temporalio.common.MetricCounter

class documentation

class MetricCounter(MetricCommon): (source)

Known subclasses: temporalio.common._NoopMetricCounter, temporalio.runtime._MetricCounter, temporalio.worker._workflow_instance._ReplaySafeMetricCounter

View In Hierarchy

Counter metric created by a metric meter.

Method add Add a value to the counter.

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 add(self, value: int, additional_attributes: MetricAttributes | None = None): (source) ¶

overridden in temporalio.common._NoopMetricCounter, temporalio.runtime._MetricCounter, temporalio.worker._workflow_instance._ReplaySafeMetricCounter

Add a value to the counter.

Parameters
value:`int`	A non-negative integer to add.
additional_attributes:`MetricAttributes \| None`	Additional attributes to append to the current set.
Raises
`ValueError`	Value is negative.
`TypeError`	Attribute values are not the expected type.