Documentation

Documentation / @zerotal/monitor / MonitorProvider

Class: MonitorProvider

Defined in: monitor/src/provider/MonitorProvider.ts:46

@zerotal/monitor — a production monitoring & queue dashboard for Zerotal.

A server-driven Flow panel ("Super Panel") with eight tabs: Overview, Requests, Exceptions, Queues, Mail, Database, Cache and System. It records live request/exception data via middleware, reads queues/scheduler/health from the running app, and exposes a Monitor facade for everything else.

Examples

// bootstrap/providers.ts
import { FlowProvider } from "@zerotal/flow";
import { MonitorProvider } from "@zerotal/monitor";
export default [FlowProvider, MonitorProvider];

// config/monitor.ts
import { MonitorConfig } from "@zerotal/monitor";
export default MonitorConfig({ path: "/monitor", auth: (u) => u?.role === "admin" });

Extends

• ServiceProvider

Constructors

Constructor

new MonitorProvider(app): MonitorProvider

Defined in: core/src/provider/ServiceProvider.ts:44

Parameters

app

Application

Returns

MonitorProvider

Inherited from

ServiceProvider.constructor

Properties

priority?

static optional priority?: number

Defined in: core/src/provider/ServiceProvider.ts:42

Boot-order tiebreak among providers with no dependsOn relationship. Lower boots earlier; defaults to 0. Handy for framework-core providers (e.g. static override priority = -100).

Inherited from

ServiceProvider.priority

app

protected app: Application

Defined in: core/src/provider/ServiceProvider.ts:44

Inherited from

ServiceProvider.app

provides

static provides: readonly ["monitor", "monitor.store", "monitor.panel"]

Defined in: monitor/src/provider/MonitorProvider.ts:47

Container tokens this provider registers. Required when using the array form of app.defer([Provider, ...]).

Example

static override provides = ['cache'] as const;

Overrides

ServiceProvider.provides

dependsOn

static dependsOn: typeof FlowProvider[]

Defined in: monitor/src/provider/MonitorProvider.ts:51

Other providers this one needs. They are pulled into the application automatically (transitively, de-duplicated) and guaranteed to boot before this provider — so you only have to register the feature you want, not its plumbing. Reference the provider classes directly:

Example

static override dependsOn = [FlowProvider];

Overrides

ServiceProvider.dependsOn

environments

static environments: AppEnvironment[]

Defined in: monitor/src/provider/MonitorProvider.ts:55

Environments in which this provider is active. Defaults to all of them.

Overrides

ServiceProvider.environments

Methods

onBooted()

onBooted(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:51

Run once all providers have booted and every binding is available.

Returns

Promise<void>

Inherited from

ServiceProvider.onBooted

onStarting()

onStarting(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:53

Run just before the app starts accepting work (e.g. the HTTP server).

Returns

Promise<void>

Inherited from

ServiceProvider.onStarting

onStarted()

onStarted(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:55

Run once the app has started.

Returns

Promise<void>

Inherited from

ServiceProvider.onStarted

onStopped()

onStopped(): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:59

Run once shutdown is complete.

Returns

Promise<void>

Inherited from

ServiceProvider.onStopped

onRequestReceived()

onRequestReceived(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:66

Called before the middleware pipeline runs.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestReceived

onRequestProcessed()

onRequestProcessed(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:69

Called after the pipeline completes and ctx.response is set.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onRequestProcessed

onResponseSent()

onResponseSent(_ctx): Promise<void>

Defined in: core/src/provider/ServiceProvider.ts:72

Called after the response has been sent to the client.

Parameters

_ctx

HttpContext

Returns

Promise<void>

Inherited from

ServiceProvider.onResponseSent

replContext()

replContext(): Record<string, unknown>

Defined in: core/src/provider/ServiceProvider.ts:81

Variables to expose in bun zt repl. Override in any provider to make its facades available by name in the REPL session.

Returns

Record<string, unknown>

Example

override replContext() { return { DB, Mail }; }

Inherited from

ServiceProvider.replContext

onRegister()

onRegister(): void

Defined in: monitor/src/provider/MonitorProvider.ts:65

Register container bindings. Runs before any provider boots; do not resolve services here.

Returns

void

Overrides

ServiceProvider.onRegister

onBooting()

onBooting(): Promise<void>

Defined in: monitor/src/provider/MonitorProvider.ts:109

Resolve and prepare services before the app is considered booted.

Returns

Promise<void>

Overrides

ServiceProvider.onBooting

onStopping()

onStopping(): Promise<void>

Defined in: monitor/src/provider/MonitorProvider.ts:303

Run when the app begins a graceful shutdown; release resources here.

Returns

Promise<void>

Overrides

ServiceProvider.onStopping