class documentation

class _NoopMetricMeter(MetricMeter): (source)

View In Hierarchy

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.

Inherited from MetricMeter:

Class Variable noop Metric meter implementation that does nothing.
def create_counter(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricCounter: (source)

Create a counter metric for adding values.

Parameters
name:strName for the metric.
description:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricCounterCounter metric.
def create_gauge(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricGauge: (source)

Create a gauge metric for setting values.

Parameters
name:strName for the metric.
description:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricGaugeGauge metric.
def create_gauge_float(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricGaugeFloat: (source)

Create a gauge metric for setting values.

Parameters
name:strName for the metric.
description:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricGaugeFloatGauge metric.
def create_histogram(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricHistogram: (source)

Create a histogram metric for recording values.

Parameters
name:strName for the metric.
description:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricHistogramHistogram metric.
def create_histogram_float(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricHistogramFloat: (source)

Create a histogram metric for recording values.

Parameters
name:strName for the metric.
description:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricHistogramFloatHistogram metric.
def create_histogram_timedelta(self, name: str, description: Optional[str] = None, unit: Optional[str] = None) -> MetricHistogramTimedelta: (source)

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:Optional[str]Optional description for the metric.
unit:Optional[str]Optional unit for the metric.
Returns
MetricHistogramTimedeltaHistogram metric.
def with_additional_attributes(self, additional_attributes: MetricAttributes) -> MetricMeter: (source)

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.