prometheus.Gauge.add()

Adds a float value to the gauge for the specified label values.

Syntax

Note:

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

add( value FLOAT, [ labels ] )
  1. value is a value of type FLOAT to add to the gauge.
  2. labels labels is a comma-separated list of label names inside square brackets that define the metric's dimensions (for example: [method,endpoint]). A label name cannot be empty; if you don't need labels, use empty brackets []

Usage

Use the prometheus.Gauge.add() method to add a specific float value to the gauge metric. The labels parameter must match the label definition of the gauge.

Example


-- Define the gauge variable
DEFINE gauge prometheus.Gauge
-- Create a gauge metric
LET gauge = prometheus.Gauge.create("gauge_hello", "a gauge", ["labela", "labelb"])
-- Add a value to the gauge
CALL gauge.add(2.6, ["valuea", "valueb"])