temporalio.common.MetricGaugeFloat

class documentation

class MetricGaugeFloat(MetricCommon): (source)

Known subclasses: temporalio.common._NoopMetricGaugeFloat, temporalio.runtime._MetricGaugeFloat, temporalio.worker._workflow_instance._ReplaySafeMetricGaugeFloat

View In Hierarchy

Gauge metric created by a metric meter.

Method set Set a value on the gauge.

Inherited from MetricCommon:

Method	`with_additional_attributes`	Create a new metric 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: float, additional_attributes: Optional[MetricAttributes] = None): (source) ¶

overridden in temporalio.common._NoopMetricGaugeFloat, temporalio.runtime._MetricGaugeFloat, temporalio.worker._workflow_instance._ReplaySafeMetricGaugeFloat

Set a value on the gauge.

Parameters
value:`float`	A non-negative float to set.
additional_attributes:`Optional[MetricAttributes]`	Additional attributes to append to the current set.
Raises
`ValueError`	Value is negative.
`TypeError`	Attribute values are not the expected type.