Documentation / @zerotal/monitor / Monitor

Variable: Monitor

const Monitor: object

Defined in: monitor/src/facades/Monitor.ts:44

Type Declaration

recordRequest

readonly recordRequest: (...a) => void | undefined

Parameters

a

...[object]

Returns

void | undefined

recordException

readonly recordException: (...a) => void | undefined

Parameters

a

...[Error | { type: string; message: string; }, string, string | null]

Returns

void | undefined

recordQuery

readonly recordQuery: (...a) => void | undefined

Parameters

a

...[object]

Returns

void | undefined

recordHttp

readonly recordHttp: (...a) => void | undefined

Parameters

a

...[object]

Returns

void | undefined

recordCache

readonly recordCache: (...a) => void | undefined

Parameters

a

...[boolean, string]

Returns

void | undefined

recordMail

readonly recordMail: (...a) => void | undefined

Parameters

a

...[Omit<MailEntry, "id" | "when"> & object]

Returns

void | undefined

recordDeploy

readonly recordDeploy: (...a) => void | undefined

Parameters

a

...[string]

Returns

void | undefined

recordJob

readonly recordJob: (...a) => void | undefined

Parameters

a

...[object]

Returns

void | undefined

context()

readonly context(data): void

Attach custom metadata to the current request or Flow action so it shows on the trace — tenant, plan, feature flags, anything useful for debugging:

Monitor.context({ tenant: tenant.id, plan: user.plan });

No-op outside a request/action scope.

Parameters

data

Record<string, unknown>

Returns

void

snapshot

readonly snapshot: (...a) => Promise<MonitorSnapshot> | undefined

Read the current aggregated snapshot (used by the page; rarely needed directly).

Parameters

a

...[MonitorRange]

Returns

Promise<MonitorSnapshot> | undefined

store

Get Signature

get store(): MonitorStore | undefined

The live store instance, if booted.

Returns

MonitorStore | undefined