LLMonitor JS API Reference

Class: LLMonitor

Constructor

MethodDescription
constructor()Initializes the LLMonitor instance.

Methods

MethodDescription
init({ appId?: string, verbose?: boolean, apiUrl?: string })Initializes the LLMonitor with the provided options.
trackEvent(type: string, event: string, data: RunEvent)Tracks an event with the provided type, event name, and data. The data parameter is of type RunEvent, which has the following structure:
PropertyDescription
typeThe type of the event. It can be one of the following: "log", "tool", "agent", "llm", "convo", "chain", "retriever", "embed", "chat", "convo".
eventThe name of the event. It can be one of the following: "start", "end", "error", "info", "warn", "feedback".
appThe ID of the app.
timestampThe timestamp of the event.
userIdThe ID of the user (optional).
userPropsThe properties of the user (optional).
parentRunIdThe ID of the parent run (optional).
extraExtra data (optional).
tagsTags associated with the event (optional).
runtimeThe runtime of the event (optional).
errorThe error object, if any, with properties message and stack (optional).
runIdThe ID of the run.
inputThe input data (optional).
outputThe output data (optional).
tokensUsageThe token usage data (optional).
MethodDescription
wrapAgent(func: Function, params?: WrapParams) -> PromiseWraps an agent's Promise to track its input, results, and any errors. Returns a Promise.
wrapTool(func: Function, params?: WrapParams) -> PromiseWraps a tool's Promise to track its input, results, and any errors. Returns a Promise.
wrapModel(func: Function, params?: WrapParams) -> PromiseWraps a model's Promise to track its input, results, and any errors. Returns a Promise.
info(message: string, extra?: any)Logs an informational message with optional extra data.
log(message: string, extra?: any)Alias for info.
warn(message: string, extra?: any)Logs a warning message with optional extra data.
`error(message: stringany, error?: any)`
flush() -> PromiseEnsures the event queue is flushed before exiting the program. Returns a Promise.

RunEvent Structure

Questions? We're here to help.