opentelemetry.sdk.metrics package

Submodules

• opentelemetry.sdk.metrics.export.aggregate
• opentelemetry.sdk.metrics.export.batcher
  • opentelemetry.sdk.metrics.export

class opentelemetry.sdk.metrics.LabelSet(labels=None)

Bases: opentelemetry.metrics.LabelSet

See opentelemetry.metrics.LabelSet.

property labels

class opentelemetry.sdk.metrics.BaseHandle(value_type, enabled, aggregator)

Bases: object

The base handle class containing common behavior for all handles.

Handles are responsible for operating on data for metric instruments for a specific set of labels.

Parameters

• value_type (Type[~ValueT]) – The type of values this handle holds (int, float).

• enabled (bool) – True if the originating instrument is enabled.

• aggregator (Aggregator) – The aggregator for this handle. Will handle aggregation upon updates and checkpointing of values for exporting.

update(value)

class opentelemetry.sdk.metrics.CounterHandle(value_type, enabled, aggregator)

Bases: opentelemetry.metrics.CounterHandle, opentelemetry.sdk.metrics.BaseHandle

add(value)

See opentelemetry.metrics.CounterHandle.add.

Return type

None

class opentelemetry.sdk.metrics.GaugeHandle(value_type, enabled, aggregator)

Bases: opentelemetry.metrics.GaugeHandle, opentelemetry.sdk.metrics.BaseHandle

set(value)

See opentelemetry.metrics.GaugeHandle.set.

Return type

None

class opentelemetry.sdk.metrics.MeasureHandle(value_type, enabled, aggregator)

Bases: opentelemetry.metrics.MeasureHandle, opentelemetry.sdk.metrics.BaseHandle

record(value)

See opentelemetry.metrics.MeasureHandle.record.

Return type

None

class opentelemetry.sdk.metrics.Metric(name, description, unit, value_type, meter, label_keys=(), enabled=True)

Bases: opentelemetry.metrics.Metric

Base class for all metric types.

Also known as metric instrument. This is the class that is used to represent a metric that is to be continuously recorded and tracked. Each metric has a set of handles that are created from the metric. See BaseHandle for information on handles.

HANDLE_TYPE

alias of BaseHandle

get_handle(label_set)

See opentelemetry.metrics.Metric.get_handle.

Return type

BaseHandle

UPDATE_FUNCTION(y)

class opentelemetry.sdk.metrics.Counter(name, description, unit, value_type, meter, label_keys=(), enabled=True)

Bases: opentelemetry.sdk.metrics.Metric, opentelemetry.metrics.Counter

See opentelemetry.metrics.Counter.

HANDLE_TYPE

alias of CounterHandle

add(value, label_set)

See opentelemetry.metrics.Counter.add.

Return type

None

UPDATE_FUNCTION(value, label_set)

See opentelemetry.metrics.Counter.add.

Return type

None

class opentelemetry.sdk.metrics.Gauge(name, description, unit, value_type, meter, label_keys=(), enabled=True)

Bases: opentelemetry.sdk.metrics.Metric, opentelemetry.metrics.Gauge

See opentelemetry.metrics.Gauge.

HANDLE_TYPE

alias of GaugeHandle

set(value, label_set)

See opentelemetry.metrics.Gauge.set.

Return type

None

UPDATE_FUNCTION(value, label_set)

See opentelemetry.metrics.Gauge.set.

Return type

None

class opentelemetry.sdk.metrics.Measure(name, description, unit, value_type, meter, label_keys=(), enabled=True)

Bases: opentelemetry.sdk.metrics.Metric, opentelemetry.metrics.Measure

See opentelemetry.metrics.Measure.

HANDLE_TYPE

alias of MeasureHandle

record(value, label_set)

See opentelemetry.metrics.Measure.record.

Return type

None

UPDATE_FUNCTION(value, label_set)

See opentelemetry.metrics.Measure.record.

Return type

None

class opentelemetry.sdk.metrics.Record(metric, label_set, aggregator)

Bases: object

Container class used for processing in the Batcher

class opentelemetry.sdk.metrics.Meter(batcher=<opentelemetry.sdk.metrics.export.batcher.UngroupedBatcher object>)

Bases: opentelemetry.metrics.Meter

See opentelemetry.metrics.Meter.

Parameters

batcher (Batcher) – The Batcher used for this meter.

collect()

Collects all the metrics created with this Meter for export.

Utilizes the batcher to create checkpoints of the current values in each aggregator belonging to the metrics that were created with this meter instance.

Return type

None

record_batch(label_set, record_tuples)

See opentelemetry.metrics.Meter.record_batch.

Return type

None

create_metric(name, description, unit, value_type, metric_type, label_keys=(), enabled=True)

See opentelemetry.metrics.Meter.create_metric.

Return type

~MetricT

get_label_set(labels)

See opentelemetry.metrics.Meter.create_metric.

This implementation encodes the labels to use as a map key.

Parameters

labels (Dict[str, str]) – The dictionary of label keys to label values.