opentelemetry-js/experimental/packages/opentelemetry-sdk-metrics-base/test/state/TemporalMetricProcessor.test.ts

/*
 * Copyright The OpenTelemetry Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as api from '@opentelemetry/api';
import { hrTime } from '@opentelemetry/core';
import * as assert from 'assert';
import { SumAggregator } from '../../src/aggregator';
import { AggregationTemporality } from '../../src/export/AggregationTemporality';
import { PointDataType } from '../../src/export/MetricData';
import { DeltaMetricProcessor } from '../../src/state/DeltaMetricProcessor';
import { MetricCollectorHandle } from '../../src/state/MetricCollector';
import { TemporalMetricProcessor } from '../../src/state/TemporalMetricProcessor';
import { assertMetricData, assertPointData, defaultInstrumentDescriptor } from '../util';

const deltaCollector1: MetricCollectorHandle = {
  aggregatorTemporality: AggregationTemporality.DELTA,
};

const deltaCollector2: MetricCollectorHandle = {
  aggregatorTemporality: AggregationTemporality.DELTA,
};

const cumulativeCollector1: MetricCollectorHandle = {
  aggregatorTemporality: AggregationTemporality.CUMULATIVE,
};

const sdkStartTime = hrTime();

describe('TemporalMetricProcessor', () => {
  describe('buildMetrics', () => {
    describe('single delta collector', () => {
      const collectors = [ deltaCollector1 ];

      it('should build metrics', () => {
        const aggregator = new SumAggregator();
        const deltaMetricStorage = new DeltaMetricProcessor(aggregator);
        const temporalMetricStorage = new TemporalMetricProcessor(aggregator);

        deltaMetricStorage.record(1, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 1);
        }

        deltaMetricStorage.record(2, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 2);
        }

        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 0);
        }
      });
    });

    describe('two delta collector', () => {
      const collectors = [ deltaCollector1, deltaCollector2 ];

      it('should build metrics', () => {
        const aggregator = new SumAggregator();
        const deltaMetricStorage = new DeltaMetricProcessor(aggregator);
        const temporalMetricStorage = new TemporalMetricProcessor(aggregator);

        deltaMetricStorage.record(1, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 1);
        }

        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector2,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 1);
        }
      });
    });

    describe('single cumulative collector', () => {
      const collectors = [ cumulativeCollector1 ];
      it('should build metrics', () => {
        const aggregator = new SumAggregator();
        const deltaMetricStorage = new DeltaMetricProcessor(aggregator);
        const temporalMetricStorage = new TemporalMetricProcessor(aggregator);

        deltaMetricStorage.record(1, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            cumulativeCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 1);
        }

        deltaMetricStorage.record(2, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            cumulativeCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 3);
        }
      });
    });

    describe('cumulative collector with delta collector', () => {
      const collectors = [ deltaCollector1, cumulativeCollector1 ];
      it('should build metrics', () => {
        const aggregator = new SumAggregator();
        const deltaMetricStorage = new DeltaMetricProcessor(aggregator);
        const temporalMetricStorage = new TemporalMetricProcessor(aggregator);

        deltaMetricStorage.record(1, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            cumulativeCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 1);
        }

        deltaMetricStorage.record(2, {}, api.context.active());
        {
          const metric = temporalMetricStorage.buildMetrics(
            deltaCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 3);
        }
        {
          const metric = temporalMetricStorage.buildMetrics(
            cumulativeCollector1,
            collectors,
            defaultInstrumentDescriptor,
            deltaMetricStorage.collect(),
            sdkStartTime,
            hrTime());

          assertMetricData(metric, PointDataType.SINGULAR);
          assert.strictEqual(metric.pointData.length, 1);
          assertPointData(metric.pointData[0], {}, 3);
        }
      });
    });
  });
});