Setu-TS
    Preparing search index...

    Interface IGauge

    Gauge: arbitrary set / inc / dec. observe sets the value.

    0.2.0

    interface IGauge {
        help: string;
        name: string;
        type: MetricType;
        dec(value?: number, labels?: Readonly<Record<string, string>>): void;
        inc(value?: number, labels?: Readonly<Record<string, string>>): void;
        observe(value?: number, labels?: Readonly<Record<string, string>>): void;
        set(value: number, labels?: Readonly<Record<string, string>>): void;
    }

    Hierarchy (View Summary)

    Index
    help name type
    dec inc observe set
    help: string

    Human-readable description.

    name: string

    Metric name (Prometheus naming conventions).

    type: MetricType

    The metric instrument kind.

    • Decrements the gauge.

      Parameters

      • Optionalvalue: number

        The value to subtract (default 1)

      • Optionallabels: Readonly<Record<string, string>>

        Label values keyed by label name

      Returns void

    • Increments the gauge.

      Parameters

      • Optionalvalue: number

        The value to add (default 1)

      • Optionallabels: Readonly<Record<string, string>>

        Label values keyed by label name

      Returns void

    • Records an observation.

      For counters the value is the increment (default 1); for gauges the new value; for histograms and summaries the observed sample.

      Parameters

      • Optionalvalue: number

        The observed value

      • Optionallabels: Readonly<Record<string, string>>

        Label values keyed by label name

      Returns void

    • Sets the gauge to a specific value.

      Parameters

      • value: number

        The new value

      • Optionallabels: Readonly<Record<string, string>>

        Label values keyed by label name

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods