PrometheusExporter
Defined in: packages/exporter-prometheus/src/index.ts:35
The exporter returned by prometheusExporter.
Extends
Section titled “Extends”Properties
Section titled “Properties”
readonlyname:string
Defined in: packages/core/dist/index.d.ts:27
Short name, used when counting errors (exporter:<name>).
Inherited from
Section titled “Inherited from”registry
Section titled “registry”
readonlyregistry: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.
Methods
Section titled “Methods”observe()
Section titled “observe()”observe(
event):void
Defined in: packages/core/dist/index.d.ts:28
Parameters
Section titled “Parameters”WireEvent
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”serve()
Section titled “serve()”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.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<MetricsServer>
shutdown()?
Section titled “shutdown()?”
optionalshutdown():void|Promise<void>
Defined in: packages/core/dist/index.d.ts:29
Returns
Section titled “Returns”void | Promise<void>