yr.Gauge.add_labels

Gauge.add_labels(labels: Dict[str, str]) → None

add label.

Parameters:

• labels (Dict[str,str]) – Both labels and key-value pairs must be strings,

• *. (and keys cannot begin with special characters like)

Raises:

ValueError – Labels are missing, or the data does not conform to Prometheus standard requirements.

Example

>>> import yr
>>> config = yr.Config(enable_metrics=True)
>>> yr.init(config)

>>> @yr.instance
... class GaugeActor:
...     def __init__(self):
...         self.labels = {"key1": "value1"}
...         self.gauge = yr.Gauge(
...             name="test",
...             description="",
...             unit="ms"
...         )
...         self.gauge.add_labels(self.labels)
...         self.gauge.set(50)
...         print("Initial labels:", self.labels)
...
...     def set_value(self, value):
...         self.gauge.set(value)
...         return {
...             "value": value,
...             "labels": self.labels
...         }
>>>
>>> actor = GaugeActor.options(name="gauge_actor").invoke()
>>> result = actor.set_value.invoke(75)
>>> print("Driver got:", yr.get(result))