Hierarchy

  • PrometheusMetrics

Constructors

  • Constructs a new Prometheus Metrics instance. The metric app_version will be set here, so ensure that getBridgeVersion will return the correct bridge version.

    Parameters

    • Optional register: Registry

      A custom registry to provide, if not using the global default.

    Returns PrometheusMetrics

Properties

AgeCounters: typeof AgeCounters = AgeCounters

Methods

  • Registers the /metrics page generating function with the containing Express app.

    Parameters

    • bridge: Bridge

      The containing Bridge instance.

    Returns void

  • 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.

    Parameters

    • func: CollectorFunction

      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.

    Returns void

  • Adds a new counter metric

    Returns

    A counter metric.

    Parameters

    • opts: CounterOpts

      Options

    Returns Counter<string>

  • Adds a new gauge metric.

    Returns

    A gauge metric.

    Parameters

    • opts: GagueOpts

      Options

    Returns Gauge<string>

  • Adds a new timer metric, represented by a prometheus Histogram.

    Returns

    A histogram metric. Once created, the value of this metric can be incremented with the startTimer method.

    Parameters

    • opts: HistogramOpts

      Options

    Returns Histogram<string>

  • Increments the value of a counter metric @param{string} name The name the metric was previously registered as. @param{Object} labels Optional object containing additional label values.

    Parameters

    • name: string
    • labels: { [label: string]: string }
      • [label: string]: string

    Returns void

  • Fetch metrics from all configured collectors

    Returns Promise<void>

  • Registers some exported metrics that relate to operations of the embedded matrix-bot-sdk. In particular, a metric is added that counts the number of calls to client API endpoints made by the client library.

    Parameters

    • appservice: Appservice

    Returns void

  • Begins a new timer observation for a timer metric. @param{string} name The name the metric was previously registered as. @param{Object} labels Optional object containing additional label values.

    Returns

    A function to be called to end the timer and report the observation.

    Parameters

    • name: string
    • labels: { [label: string]: string }
      • [label: string]: string

    Returns (() => void)

      • (): void
      • Begins a new timer observation for a timer metric. @param{string} name The name the metric was previously registered as. @param{Object} labels Optional object containing additional label values.

        Returns

        A function to be called to end the timer and report the observation.

        Returns void

Generated using TypeDoc