Class SumAggregator

Basic aggregator which calculates a Sum from individual measurements.

Hierarchy

SumAggregator

Implements

Aggregator<SumAccumulation>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SumAggregator(monotonic: boolean): SumAggregator

- Defined in packages/sdk-metrics/src/aggregator/Sum.ts:61
Parameters
- monotonic: boolean
Returns SumAggregator

Properties

kind

kind: SUM = AggregatorKind.SUM

The kind of the aggregator.

monotonic

monotonic: boolean

Methods

createAccumulation

createAccumulation(startTime: HrTime): SumAccumulation

Implementation of Aggregator.createAccumulation
- Defined in packages/sdk-metrics/src/aggregator/Sum.ts:63
Create a clean state of accumulation.

Parameters
- startTime: HrTime
Returns SumAccumulation

diff

diff(previous: SumAccumulation, current: SumAccumulation): SumAccumulation

Implementation of Aggregator.diff
- Defined in packages/sdk-metrics/src/aggregator/Sum.ts:91
Returns a new DELTA aggregation by comparing two cumulative measurements.

Parameters
- previous: SumAccumulation
- current: SumAccumulation
Returns SumAccumulation

merge

merge(previous: SumAccumulation, delta: SumAccumulation): SumAccumulation

Implementation of Aggregator.merge
- Defined in packages/sdk-metrics/src/aggregator/Sum.ts:70
Returns the result of the merge of the given accumulations.

Parameters
- previous: SumAccumulation
- delta: SumAccumulation
Returns SumAccumulation

toMetricData

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

Implementation of Aggregator.toMetricData
- Defined in packages/sdk-metrics/src/aggregator/Sum.ts:114
Returns the MetricData that this Aggregator will produce.

Parameters
- descriptor: MetricDescriptor
- aggregationTemporality: AggregationTemporality
- accumulationByAttributes: AccumulationRecord<SumAccumulation>[]
- endTime: HrTime
Returns Maybe<SumMetricData>

Generated using TypeDoc