temporalio.common.MetricGauge

class documentation

class MetricGauge(ABC): (source)

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) ¶

overridden in temporalio.common._NoopMetricGauge, temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge

Set a value on the gauge.

Parameters
value:`int`	A non-negative integer 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.

@abstractmethod
def with_additional_attributes(self, additional_attributes: MetricAttributes) -> MetricGauge: (source) ¶

overridden in temporalio.common._NoopMetricGauge, temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge

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

Parameters
additional_attributes:`MetricAttributes`	Additional attributes to append to the current set.
Returns
`MetricGauge`	New gauge.
Raises
`TypeError`	Attribute values are not the expected type.

overridden in temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge

Description for the metric if any.

overridden in temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge

Name for the metric.

overridden in temporalio.runtime._MetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGauge

Unit for the metric if any.