class documentation

Gauge metric created by a metric meter.

Method set Set a value on the gauge.
Method with_additional_attributes Create a new gauge with the given attributes appended to the current set.
Property description Description for the metric if any.
Property name Name for the metric.
Property unit Unit for the metric if any.
@abstractmethod
def set(self, value: int, additional_attributes: Optional[MetricAttributes] = None): (source)

Set a value on the gauge.

Parameters
value:intA non-negative integer to set.
additional_attributes:Optional[MetricAttributes]Additional attributes to append to the current set.
Raises
ValueErrorValue is negative.
TypeErrorAttribute values are not the expected type.
@abstractmethod
def with_additional_attributes(self, additional_attributes: MetricAttributes) -> MetricGauge: (source)

Create a new gauge with the given attributes appended to the current set.

Parameters
additional_attributes:MetricAttributesAdditional attributes to append to the current set.
Returns
MetricGaugeNew gauge.
Raises
TypeErrorAttribute values are not the expected type.