temporalio.common.MetricCommon

class documentation

class MetricCommon(ABC): (source)

Known subclasses: temporalio.common.MetricCounter, temporalio.common.MetricGauge, temporalio.common.MetricGaugeFloat, temporalio.common.MetricHistogram, temporalio.common.MetricHistogramFloat, temporalio.common.MetricHistogramTimedelta, temporalio.common._NoopMetric, temporalio.runtime._MetricCommon, temporalio.worker._workflow_instance._ReplaySafeMetricCommon

View In Hierarchy

Base for all metrics.

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 with_additional_attributes(self, additional_attributes: MetricAttributes) -> Self: (source)
overridden in temporalio.common._NoopMetric, temporalio.runtime._MetricCommon, temporalio.worker._workflow_instance._ReplaySafeMetricCommon

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

Parameters
additional_attributes:MetricAttributesAdditional attributes to append to the current set.
Returns
SelfNew metric.
Raises
TypeErrorAttribute values are not the expected type.
@property
@abstractmethod
description: Optional[str] = (source)
overridden in temporalio.common._NoopMetric, temporalio.runtime._MetricCommon, temporalio.worker._workflow_instance._ReplaySafeMetricCommon

Description for the metric if any.

@property
@abstractmethod
name: str = (source)
overridden in temporalio.common._NoopMetric, temporalio.runtime._MetricCommon, temporalio.worker._workflow_instance._ReplaySafeMetricCommon

Name for the metric.

@property
@abstractmethod
unit: Optional[str] = (source)
overridden in temporalio.common._NoopMetric, temporalio.runtime._MetricCommon, temporalio.worker._workflow_instance._ReplaySafeMetricCommon

Unit for the metric if any.