temporalio.common.MetricHistogram

class documentation

class MetricHistogram(MetricCommon): (source)

Known subclasses: temporalio.common._NoopMetricHistogram, temporalio.runtime._MetricHistogram, temporalio.worker._workflow_instance._ReplaySafeMetricHistogram

View In Hierarchy

Histogram metric created by a metric meter.

Method record Record a value on the histogram.

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

overridden in temporalio.common._NoopMetricHistogram, temporalio.runtime._MetricHistogram, temporalio.worker._workflow_instance._ReplaySafeMetricHistogram

Record a value on the histogram.

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