temporalio.worker._workflow_instance.

class documentation

Undocumented

Method	`__init__`	Undocumented
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.
Instance Variable	`_underlying`	Undocumented

Inherited from MetricMeter:

Class Variable noop Metric meter implementation that does nothing.

def __init__(self, underlying: temporalio.common.MetricMeter): (source) ¶

Undocumented

def create_counter(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricCounter: (source) ¶

overrides temporalio.common.MetricMeter.create_counter

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
`temporalio.common.MetricCounter`	Counter metric.

def create_gauge(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricGauge: (source) ¶

overrides temporalio.common.MetricMeter.create_gauge

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
`temporalio.common.MetricGauge`	Gauge metric.

def create_gauge_float(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricGaugeFloat: (source) ¶

overrides temporalio.common.MetricMeter.create_gauge_float

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
`temporalio.common.MetricGaugeFloat`	Gauge metric.

def create_histogram(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricHistogram: (source) ¶

overrides temporalio.common.MetricMeter.create_histogram

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
`temporalio.common.MetricHistogram`	Histogram metric.

def create_histogram_float(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricHistogramFloat: (source) ¶

overrides temporalio.common.MetricMeter.create_histogram_float

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
`temporalio.common.MetricHistogramFloat`	Histogram metric.

def create_histogram_timedelta(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> temporalio.common.MetricHistogramTimedelta: (source) ¶

overrides temporalio.common.MetricMeter.create_histogram_timedelta

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:`str`	Name for the metric.
description:`Optional[str]`	Optional description for the metric.
unit:`Optional[str]`	Optional unit for the metric.
Returns
`temporalio.common.MetricHistogramTimedelta`	Histogram metric.

def with_additional_attributes(self, additional_attributes: temporalio.common.MetricAttributes) -> temporalio.common.MetricMeter: (source) ¶

overrides temporalio.common.MetricMeter.with_additional_attributes

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

Parameters
additional_attributes:`temporalio.common.MetricAttributes`	Additional attributes to append to the current set.
Returns
`temporalio.common.MetricMeter`	New metric meter.
Raises
`TypeError`	Attribute values are not the expected type.

Undocumented

temporalio.worker._workflow_instance._ReplaySafeMetricMeter