Class Metric<T>Abstract

Optional Readonlydescription

Optional Readonlylabels

Readonlyname

Readonlytype

Abstractstringify

• stringify(): Promise<string>

  Serializes the metric to Prometheus exposition format.

  Returns Promise<string>

  A Promise resolving to the serialized string.

StaticcleanText

• cleanText(input?: string): string | undefined

  Sanitizes a metric name by removing or replacing invalid characters.

  Prometheus metric names must match [a-zA-Z_:][a-zA-Z0-9_:]* This removes hyphens, parens; replaces slashes and spaces with underscores.

  Parameters

  • Optionalinput: string

    The raw metric name.

  Returns string | undefined

  The cleaned metric name.

Staticconcat

• concat(
      format?: "prometheus" | "openmetrics",
      ...metrics: Metric<MetricType>[],
  ): Promise<string>

  Concatenates multiple metrics into a single exposition string.

  Parameters

  • format: "prometheus" | "openmetrics" = 'prometheus'

    used to set the metric type

  • ...metrics: Metric<MetricType>[]

    The metrics to serialize.

  Returns Promise<string>

  A Promise resolving to the combined string.

StaticlabelString

• labelString(labels?: Record<string, string | number>): string

  Converts a label object to a Prometheus label string (e.g., {foo="bar"}).

  Parameters

  • Optionallabels: Record<string, string | number>

    The label key-value pairs.

  Returns string

  The formatted label string.