IFClite TypeScript API
    Preparing search index...
    Index
    • Prometheus-style bucketed histogram. buckets are upper bounds (e.g. [5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000]). Each observation increments every bucket whose upper bound it doesn't exceed, plus sum and count. Render output uses the conventional <name>_bucket{le="<bound>"} labels.

      Parameters

      • name: string
      • buckets: readonly number[]
      • help: string

      Returns { buckets: number[]; observe: (value: number, labels?: LabelValues) => void }

    • Register or fetch a counter. Counters are monotonic (only inc).

      Parameters

      • name: string
      • help: string

      Returns {
          get: (labels?: LabelValues) => number;
          inc: (n?: number, labels?: LabelValues) => void;
      }

    • Register or fetch a gauge. Gauges can move in any direction.

      Parameters

      • name: string
      • help: string

      Returns {
          dec: (n?: number, labels?: LabelValues) => void;
          get: (labels?: LabelValues) => number;
          inc: (n?: number, labels?: LabelValues) => void;
          reset: () => void;
          set: (value: number, labels?: LabelValues) => void;
      }

      • dec: (n?: number, labels?: LabelValues) => void
      • get: (labels?: LabelValues) => number
      • inc: (n?: number, labels?: LabelValues) => void
      • reset: () => void

        Drop every label series. For a gauge whose label set is derived from a peer-chosen identifier (e.g. a room id) and refreshed by re-setting each live member on every scrape, a series for a member that has since disappeared (a room that unloaded) is never overwritten and would otherwise report its last known value forever. Call this before the refresh loop so the render reflects only currently-live members.

      • set: (value: number, labels?: LabelValues) => void
    • Tiny histogram: tracks sum and count. Apps can compute average client-side. Real bucketed histograms are also available via bucketedHistogram(name, buckets, help).

      Parameters

      • name: string
      • help: string

      Returns {
          mean: (labels?: LabelValues) => number;
          observe: (value: number, labels?: LabelValues) => void;
      }

    • Render the full registry as Prometheus text format.

      Returns string