Documentation / @zerotal/monitor / MonitorStore

Class: MonitorStore

Defined in: monitor/src/MonitorStore.ts:133

Constructors

Constructor

new MonitorStore(opts?): MonitorStore

Defined in: monitor/src/MonitorStore.ts:150

Parameters

opts?

MonitorStoreOptions = {}

Returns

MonitorStore

Methods

bindApp()

bindApp(app): void

Defined in: monitor/src/MonitorStore.ts:164

Bind the IoC app so live sources (queue/scheduler/health) can be read.

Parameters

app

AppShape

Returns

void

recordRequest()

recordRequest(r): void

Defined in: monitor/src/MonitorStore.ts:170

Parameters

r

method

string

path

string

status

number

ms

number

queries?

RequestQuery[]

logs?

unknown

nplus?

boolean

spans?

unknown

user?

string | null

ip?

string | null

memKb?

number

context?

Record<string, unknown>

payload?

RequestPayload | null

error?

string | null

Returns

void

recordException()

recordException(error, location?, user?): void

Defined in: monitor/src/MonitorStore.ts:205

Parameters

error

Error | { type: string; message: string; }

location?

string

user?

string | null

Returns

void

recordQuery()

recordQuery(q): void

Defined in: monitor/src/MonitorStore.ts:227

Parameters

q

sql

string

ms

number

location?

string

Returns

void

recordHttp()

recordHttp(h): void

Defined in: monitor/src/MonitorStore.ts:236

Parameters

h

host

string

ms

number

error?

boolean

Returns

void

recordCache()

recordCache(hit, key?): void

Defined in: monitor/src/MonitorStore.ts:245

Parameters

hit

boolean

key?

string

Returns

void

recordMail()

recordMail(m): void

Defined in: monitor/src/MonitorStore.ts:249

Parameters

m

Omit<MailEntry, "id" | "when"> & object

Returns

void

recordDeploy()

recordDeploy(sha): void

Defined in: monitor/src/MonitorStore.ts:261

Parameters

sha

string

Returns

void

recordJob()

recordJob(job): void

Defined in: monitor/src/MonitorStore.ts:265

Parameters

job

status

string

className?

string

queue?

string

ms?

number

error?

string | null

Returns

void

recordEvent()

recordEvent(e): void

Defined in: monitor/src/MonitorStore.ts:283

Record a generic framework event (security, transaction, migration, N+1, WS, …).

Parameters

e

kind

string

label

string

status?

"info" | "warn" | "ok" | "bad"

route?

string | null

data?

Record<string, unknown>

Returns

void

bufferQuery()

bufferQuery(ctx, q): void

Defined in: monitor/src/MonitorStore.ts:307

Buffer one query span against the request context it ran under.

Parameters

ctx

object

q

RequestQuery

Returns

void

markNPlus()

markNPlus(ctx): void

Defined in: monitor/src/MonitorStore.ts:312

Flag the request context as having triggered an N+1 pattern.

Parameters

ctx

object

Returns

void

collectRequestState()

collectRequestState(ctx): RequestState

Defined in: monitor/src/MonitorStore.ts:317

Read and clear the buffered correlation state for a finalised request/action.

Parameters

ctx

object

Returns

RequestState

toggleQueuePaused()

toggleQueuePaused(name): boolean

Defined in: monitor/src/MonitorStore.ts:324

Toggle a queue's paused state. Returns the new paused state.

Parameters

name

string

Returns

boolean

retryFailed()

retryFailed(id): Promise<boolean>

Defined in: monitor/src/MonitorStore.ts:335

Retry a failed job (real if a queue is bound) and drop it from the list.

Parameters

id

number

Returns

Promise<boolean>

forgetFailed()

forgetFailed(id): Promise<boolean>

Defined in: monitor/src/MonitorStore.ts:343

Permanently forget a failed job.

Parameters

id

number

Returns

Promise<boolean>

requeueDead()

requeueDead(id): Promise<boolean>

Defined in: monitor/src/MonitorStore.ts:351

Requeue a dead-letter job: re-dispatch it (if a queue is bound) and drop it from the view.

Parameters

id

number

Returns

Promise<boolean>

prune()

prune(): number

Defined in: monitor/src/MonitorStore.ts:361

Prune data older than the retention window (delete or archive). Returns rows removed.

Returns

number

wipe()

wipe(): number

Defined in: monitor/src/MonitorStore.ts:368

Wipe all recorded data. Returns rows removed.

Returns

number

storageInfo()

storageInfo(): StorageInfo

Defined in: monitor/src/MonitorStore.ts:373

Returns

StorageInfo

retentionDays()

retentionDays(): number

Defined in: monitor/src/MonitorStore.ts:376

Returns

number

retentionMode()

retentionMode(): RetentionMode

Defined in: monitor/src/MonitorStore.ts:379

Returns

RetentionMode

dispose()

dispose(): void

Defined in: monitor/src/MonitorStore.ts:383

Returns

void

snapshot()

snapshot(range?): Promise<MonitorSnapshot>

Defined in: monitor/src/MonitorStore.ts:389

Parameters

range?

MonitorRange = "live"

Returns

Promise<MonitorSnapshot>

routeDetail()

routeDetail(method, path, range?): Promise<RouteDetail>

Defined in: monitor/src/MonitorStore.ts:503

Drill into a single route: latency percentiles, throughput/latency/error series, status-class breakdown, and the recent + slowest requests — all from mon_requests filtered to one method+path within the window.

Parameters

method

string

path

string

range?

MonitorRange = "live"

Returns

Promise<RouteDetail>