temporalio.runtime._MetricCommon

class documentation

class _MetricCommon(temporalio.common.MetricCommon, Generic[_CoreMetricType]): (source)

Known subclasses: temporalio.runtime._MetricCounter, temporalio.runtime._MetricGauge, temporalio.runtime._MetricGaugeFloat, temporalio.runtime._MetricHistogram, temporalio.runtime._MetricHistogramFloat, temporalio.runtime._MetricHistogramTimedelta

Constructor: _MetricCommon(name, description, unit, core_metric, ...)

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	`_core_attrs`	Undocumented
Instance Variable	`_core_metric`	Undocumented
Instance Variable	`_description`	Undocumented
Instance Variable	`_name`	Undocumented
Instance Variable	`_unit`	Undocumented

def __init__(self, name: str, description: Optional[str], unit: Optional[str], core_metric: _CoreMetricType, core_attrs: temporalio.bridge.metric.MetricAttributes): (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.MetricAttributes`	Additional attributes to append to the current set.
Returns
`Self`	New metric.
Raises
`TypeError`	Attribute 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.

_core_attrs = (source) ¶

Undocumented

_core_metric = (source) ¶

Undocumented

_description = (source) ¶

Undocumented

_name = (source) ¶

Undocumented

_unit = (source) ¶

Undocumented