temporalio.common.MetricHistogram

class documentation

class MetricHistogram(ABC): (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.
Method	`with_additional_attributes`	Create a new histogram 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: Optional[MetricAttributes] = 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:`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) -> MetricHistogram: (source) ¶

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

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

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

@property
@abstractmethod
description: Optional[str] = (source) ¶

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

Description for the metric if any.

@property
@abstractmethod
name: str = (source) ¶

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

Name for the metric.

@property
@abstractmethod
unit: Optional[str] = (source) ¶

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

Unit for the metric if any.