[ Web Proxy ]
URL:
Viewing: https://python.temporal.io/temporalio.common.MetricMeter.html [Back]  [Original]
temporalio.common.MetricMeter
Temporal Python API Documentation Modules Classes Names
search in docstrings

For more information on the search, visit the help page.

Class MetricMeter
Methods
Attributes
Module common
Classes
Functions
Variables

temporalio.common.MetricMeter

Toggle Private API
class documentation

class MetricMeter(ABC): (source)

Known subclasses: temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

View In Hierarchy

Metric meter for recording metrics.

Method create_counter Create a counter metric for adding values.
Method create_gauge Create a gauge metric for setting values.
Method create_gauge_float Create a gauge metric for setting values.
Method create_histogram Create a histogram metric for recording values.
Method create_histogram_float Create a histogram metric for recording values.
Method create_histogram_timedelta Create a histogram metric for recording values.
Method with_additional_attributes Create a new metric meter with the given attributes appended to the current set.
Class Variable noop Metric meter implementation that does nothing.
@abstractmethod
def create_counter(self, name: str, description: str | None = None, unit: str | None = None) -> MetricCounter: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a counter metric for adding values.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricCounterCounter metric.
@abstractmethod
def create_gauge(self, name: str, description: str | None = None, unit: str | None = None) -> MetricGauge: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a gauge metric for setting values.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricGaugeGauge metric.
@abstractmethod
def create_gauge_float(self, name: str, description: str | None = None, unit: str | None = None) -> MetricGaugeFloat: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a gauge metric for setting values.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricGaugeFloatGauge metric.
@abstractmethod
def create_histogram(self, name: str, description: str | None = None, unit: str | None = None) -> MetricHistogram: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a histogram metric for recording values.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricHistogramHistogram metric.
@abstractmethod
def create_histogram_float(self, name: str, description: str | None = None, unit: str | None = None) -> MetricHistogramFloat: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a histogram metric for recording values.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricHistogramFloatHistogram metric.
@abstractmethod
def create_histogram_timedelta(self, name: str, description: str | None = None, unit: str | None = None) -> MetricHistogramTimedelta: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

Create a histogram metric for recording values.

Note, duration precision is millisecond. Also note, if "unit" is set as "duration", it will be converted to "ms" or "s" on the way out.

Parameters
name:strName for the metric.
description:str | NoneOptional description for the metric.
unit:str | NoneOptional unit for the metric.
Returns
MetricHistogramTimedeltaHistogram metric.
@abstractmethod
def with_additional_attributes(self, additional_attributes: MetricAttributes) -> MetricMeter: (source)
overridden in temporalio.common._NoopMetricMeter, temporalio.runtime._MetricMeter, temporalio.worker._workflow_instance._ReplaySafeMetricMeter

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

Parameters
additional_attributes:MetricAttributesAdditional attributes to append to the current set.
Returns
MetricMeterNew metric meter.
Raises
TypeErrorAttribute values are not the expected type.
noop: ClassVar[MetricMeter] = (source)

Metric meter implementation that does nothing.

API Documentation for Temporal Python, generated by pydoctor 25.10.1 at 2026-08-26 20:38:52.
Web Proxy Viewer  |  New URL  |  Original Page