prometheus.Gauge.set()

Sets the gauge to a specific float value for the specified label values.

Syntax

Note:

In this syntax diagram, the square brackets ([ ]) are part of the syntax.

set( value FLOAT, [ labels ] )
  1. value sets the gauge to a value of type FLOAT.
  2. labels is a comma-separated list of label values inside square brackets, one for each label name declared when the metric was created, in the same order. Where the metric declares no label names, use empty brackets [].

Usage

Use the prometheus.Gauge.set() method to set the gauge metric to a specific float value. The label values change from one call to the next. For example, with the label name ["category"] declared, set(4, ["books"]) sets the level recorded for that category.

Example


-- Define the gauge variable
DEFINE gauge prometheus.Gauge
-- Create a gauge metric
LET gauge = prometheus.Gauge.create("gauge_basket_items", "items in the basket",
                                    ["category"])
-- Set the gauge to a value
CALL gauge.set(4, ["books"])