A custom registry to provide, if not using the global default.
Registers the /metrics page generating function with the
containing Express app.
The containing Bridge instance.
Adds a new collector function. These collector functions are run whenever the /metrics page is about to be generated, allowing code to update values of gauges.
A new collector function. This function is passed no arguments and is not expected to return anything. It runs purely to have a side-effect on previously registered gauges.
Adds a new counter metric
Options
A counter metric.
Adds a new gauge metric.
Options
A gauge metric.
Adds a new timer metric, represented by a prometheus Histogram.
Options
A histogram metric.
Once created, the value of this metric can be incremented with the
startTimer method.
Increments the value of a counter metric
Fetch metrics from all configured collectors
Registers some exported metrics that expose counts of various kinds of objects within the bridge.
A function that when invoked returns the current counts of various items in the bridge.
Registers some exported metrics that relate to operations of the embedded matrix-js-sdk. In particular, a metric is added that counts the number of calls to client API endpoints made by the client library.
Begins a new timer observation for a timer metric.
A function to be called to end the timer and report the observation.
Begins a new timer observation for a timer metric.
A function to be called to end the timer and report the observation.
Generated using TypeDoc
Constructs a new Prometheus Metrics instance. The metric
app_versionwill be set here, so ensure thatgetBridgeVersionwill return the correct bridge version.