prometheus.Gauge.sub()

Subtracts a float value from the gauge for the specified label values.

Syntax

Note:

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

sub( value FLOAT, [ labels ] )
  1. value is a value of type FLOAT to subtract from the gauge.
  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.sub() method to subtract a specific float value from the gauge metric. The label values change from one call to the next. For example, with the label name ["category"] declared, sub(2, ["books"]) subtracts from 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"])
-- Subtract a value from the gauge
CALL gauge.sub(2, ["books"])