Skip to content

PrometheusExporter

Defined in: packages/exporter-prometheus/src/index.ts:35

The exporter returned by prometheusExporter.

readonly name: string

Defined in: packages/core/dist/index.d.ts:27

Short name, used when counting errors (exporter:<name>).

ShardlensExporter.name


readonly registry: Registry

Defined in: packages/exporter-prometheus/src/index.ts:37

The registry holding the Shardlens metrics. Merge it with yours, or serve it with PrometheusExporter.serve.

observe(event): void

Defined in: packages/core/dist/index.d.ts:28

WireEvent

void

ShardlensExporter.observe


serve(options?): Promise<MetricsServer>

Defined in: packages/exporter-prometheus/src/index.ts:43

Serves GET /metrics on its own small HTTP server. Listens on 127.0.0.1 unless you choose another host: put a firewall or reverse proxy in front before exposing it. Never rejects: if the port is taken, it warns and tries again every 10 seconds.

ServeOptions

Promise<MetricsServer>


optional shutdown(): void | Promise<void>

Defined in: packages/core/dist/index.d.ts:29

void | Promise<void>

ShardlensExporter.shutdown