apache_beam.internal.metrics.cells module

This file contains internal metric cell classes. A metric cell is used to accumulate in-memory changes to a metric. It represents a specific metric in a single context.

For internal use only. No backwards compatibility guarantees.

class apache_beam.internal.metrics.cells.HistogramCell(bucket_type)

Bases: apache_beam.metrics.cells.MetricCell

For internal use only; no backwards-compatibility guarantees.

Tracks the current value and delta for a histogram metric.

Each cell tracks the state of a metric independently per context per bundle. Therefore, each metric has a different cell in each bundle, that is later aggregated.

This class is thread safe since underlying histogram object is thread safe.

reset()

combine(other)

update(value)

get_cumulative()

to_runner_api_monitoring_info(name, transform_id)

class apache_beam.internal.metrics.cells.HistogramCellFactory(bucket_type)

Bases: apache_beam.metrics.cells.MetricCellFactory

class apache_beam.internal.metrics.cells.HistogramResult(data)

Bases: object

p99

p95

p90

class apache_beam.internal.metrics.cells.HistogramData(histogram)

Bases: object

For internal use only; no backwards-compatibility guarantees.

The data structure that holds data about a histogram metric.

This object is not thread safe, so it’s not supposed to be modified outside the HistogramCell.

get_cumulative()

combine(other)

class apache_beam.internal.metrics.cells.HistogramAggregator(bucket_type)

Bases: apache_beam.metrics.cells.MetricAggregator

For internal use only; no backwards-compatibility guarantees.

Aggregator for Histogram metric data during pipeline execution.

Values aggregated should be HistogramData objects.

identity_element()

combine(x, y)

result(x)