temporalio.common.MetricMeter

class documentation

class MetricMeter(ABC): (source)

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_histogram`	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: Optional[str] = None, unit: Optional[str] = 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:`str`	Name for the metric.
description:`Optional[str]`	Optional description for the metric.
unit:`Optional[str]`	Optional unit for the metric.
Returns
`MetricCounter`	Counter metric.

@abstractmethod
def create_gauge(self, name: str, description: Optional[str] = None, unit: Optional[str] = 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:`str`	Name for the metric.
description:`Optional[str]`	Optional description for the metric.
unit:`Optional[str]`	Optional unit for the metric.
Returns
`MetricGauge`	Gauge metric.

@abstractmethod
def create_histogram(self, name: str, description: Optional[str] = None, unit: Optional[str] = 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:`str`	Name for the metric.
description:`Optional[str]`	Optional description for the metric.
unit:`Optional[str]`	Optional unit for the metric.
Returns
`MetricHistogram`	Histogram 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:`MetricAttributes`	Additional attributes to append to the current set.
Returns
`MetricMeter`	New metric meter.
Raises
`TypeError`	Attribute values are not the expected type.

Metric meter implementation that does nothing.