Interface Aggregator<T>

Base interface for aggregators. Aggregators are responsible for holding aggregated values and taking a snapshot of these values upon export.

Type Parameters

T

Hierarchy

Aggregator

Implemented by

Index

Properties

kind

Methods

Properties

kind

kind: AggregatorKind

The kind of the aggregator.

Methods

createAccumulation

createAccumulation(startTime: HrTime): T

- Defined in packages/sdk-metrics/src/aggregator/types.ts:104
Create a clean state of accumulation.

Parameters
- startTime: HrTime
Returns T

diff

diff(previous: T, current: T): T

- Defined in packages/sdk-metrics/src/aggregator/types.ts:125
Returns a new DELTA aggregation by comparing two cumulative measurements.

Parameters
- previous: T
  
  the previously captured accumulation
- current: T
  
  the newly captured (cumulative) accumulation
Returns T
The resulting delta accumulation

merge

merge(previous: T, delta: T): T

- Defined in packages/sdk-metrics/src/aggregator/types.ts:116
Returns the result of the merge of the given accumulations.

This should always assume that the accumulations do not overlap and merge together for a new cumulative report.

Parameters
- previous: T
  
  the previously captured accumulation
- delta: T
  
  the newly captured (delta) accumulation
Returns T
the result of the merge of the given accumulations

toMetricData

toMetricData(descriptor: MetricDescriptor, aggregationTemporality: AggregationTemporality, accumulationByAttributes: AccumulationRecord<T>[], endTime: HrTime): Maybe<MetricData>

- Defined in packages/sdk-metrics/src/aggregator/types.ts:136
Returns the MetricData that this Aggregator will produce.

Parameters
- descriptor: MetricDescriptor
  
  the metric descriptor.
- aggregationTemporality: AggregationTemporality
  
  the temporality of the resulting MetricData
- accumulationByAttributes: AccumulationRecord<T>[]
  
  the array of attributes and accumulation pairs.
- endTime: HrTime
  
  the end time of the metric data.
Returns Maybe<MetricData>
the MetricData that this Aggregator will produce.

Generated using TypeDoc