temporalio.runtime._MetricHistogram

class documentation

class _MetricHistogram(temporalio.common.MetricHistogram): (source)

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

Undocumented

Method	`__init__`	Undocumented
Method	`record`	Record a value on the histogram.
Method	`with_additional_attributes`	Create a new histogram 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: temporalio.bridge.metric.MetricHistogram, core_attrs: temporalio.bridge.metric.MetricAttributes): (source) ¶

Undocumented

def record(self, value: int, additional_attributes: Optional[temporalio.common.MetricAttributes] = None): (source) ¶

overrides temporalio.common.MetricHistogram.record

Record a value on the histogram.

Parameters
value:`int`	A non-negative integer to record.
additional_attributes:`Optional[temporalio.common.MetricAttributes]`	Additional attributes to append to the current set.
Raises
`ValueError`	Value is negative.
`TypeError`	Attribute values are not the expected type.

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

overrides temporalio.common.MetricHistogram.with_additional_attributes

Create a new histogram 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.MetricHistogram`	New histogram.
Raises
`TypeError`	Attribute values are not the expected type.

@property
description: Optional[str] = (source) ¶

overrides temporalio.common.MetricHistogram.description

Description for the metric if any.

@property
name: str = (source) ¶

overrides temporalio.common.MetricHistogram.name

Name for the metric.

@property
unit: Optional[str] = (source) ¶

overrides temporalio.common.MetricHistogram.unit

Unit for the metric if any.

_core_attrs = (source) ¶

Undocumented

_core_metric = (source) ¶

Undocumented

_description = (source) ¶

Undocumented

_name = (source) ¶

Undocumented

_unit = (source) ¶

Undocumented