temporalio.worker._workflow_instance._ReplaySafeMetricCommon

class documentation

class _ReplaySafeMetricCommon(temporalio.common.MetricCommon, Generic[_MetricType]): (source)

Known subclasses: temporalio.worker._workflow_instance._ReplaySafeMetricCounter, temporalio.worker._workflow_instance._ReplaySafeMetricGauge, temporalio.worker._workflow_instance._ReplaySafeMetricGaugeFloat, temporalio.worker._workflow_instance._ReplaySafeMetricHistogram, temporalio.worker._workflow_instance._ReplaySafeMetricHistogramFloat, temporalio.worker._workflow_instance._ReplaySafeMetricHistogramTimedelta

Constructor: _ReplaySafeMetricCommon(underlying)

View In Hierarchy

Undocumented

Method __init__ Undocumented
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.
Instance Variable _underlying Undocumented
def __init__(self, underlying: _MetricType): (source)

Undocumented

def with_additional_attributes(self, additional_attributes: temporalio.common.MetricAttributes) -> Self: (source)
overrides temporalio.common.MetricCommon.with_additional_attributes

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

Parameters
additional_attributes:temporalio.common.MetricAttributesAdditional attributes to append to the current set.
Returns
SelfNew metric.
Raises
TypeErrorAttribute values are not the expected type.
@property
description: Optional[str] = (source)
overrides temporalio.common.MetricCommon.description

Description for the metric if any.

@property
name: str = (source)
overrides temporalio.common.MetricCommon.name

Name for the metric.

@property
unit: Optional[str] = (source)
overrides temporalio.common.MetricCommon.unit

Unit for the metric if any.

_underlying = (source)

Undocumented