opentelemetry.sdk.metrics.export.batcher

class opentelemetry.sdk.metrics.export.batcher.Batcher(stateful)[source]

Bases: abc.ABC

Base class for all batcher types.

The batcher is responsible for storing the aggregators and aggregated values received from updates from metrics in the meter. The stored values will be sent to an exporter for exporting.

aggregator_for(metric_type)[source]

Returns an aggregator based on metric type.

Aggregators keep track of and updates values when metrics get updated.

Return type

Aggregator

checkpoint_set()[source]

Returns a list of MetricRecords used for exporting.

The list of MetricRecords is a snapshot created from the current data in all of the aggregators in this batcher.

Return type

Sequence[MetricRecord]

finished_collection()[source]

Performs certain post-export logic.

For batchers that are stateless, resets the batch map.

abstract process(record)[source]

Stores record information to be ready for exporting.

Depending on type of batcher, performs pre-export logic, such as filtering records based off of keys.

Return type

None

class opentelemetry.sdk.metrics.export.batcher.UngroupedBatcher(stateful)[source]

Bases: opentelemetry.sdk.metrics.export.batcher.Batcher

Accepts all records and passes them for exporting

process(record)[source]

Stores record information to be ready for exporting.

Depending on type of batcher, performs pre-export logic, such as filtering records based off of keys.