io.opentelemetry.sdk.metrics.internal.data.ImmutableMetricData Maven / Gradle / Ivy

Go to download
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.sdk.metrics.internal.data;

import com.google.auto.value.AutoValue;
import io.opentelemetry.sdk.common.InstrumentationScopeInfo;
import io.opentelemetry.sdk.metrics.data.Data;
import io.opentelemetry.sdk.metrics.data.DoublePointData;
import io.opentelemetry.sdk.metrics.data.ExponentialHistogramData;
import io.opentelemetry.sdk.metrics.data.GaugeData;
import io.opentelemetry.sdk.metrics.data.HistogramData;
import io.opentelemetry.sdk.metrics.data.LongPointData;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.data.MetricDataType;
import io.opentelemetry.sdk.metrics.data.SumData;
import io.opentelemetry.sdk.metrics.data.SummaryData;
import io.opentelemetry.sdk.resources.Resource;
import javax.annotation.concurrent.Immutable;

/**
 * A container of metrics.
 *
 * This class is internal and is hence not for public use. Its APIs are unstable and can change
 * at any time.
 */
@Immutable
@AutoValue
public abstract class ImmutableMetricData implements MetricData {

  /**
   * Returns a new MetricData with a {@link MetricDataType#DOUBLE_GAUGE} type.
   *
   * @return a new MetricData with a {@link MetricDataType#DOUBLE_GAUGE} type.
   */
  public static MetricData createDoubleGauge(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      GaugeData data) {
    return ImmutableMetricData.create(
        resource,
        instrumentationScopeInfo,
        name,
        description,
        unit,
        MetricDataType.DOUBLE_GAUGE,
        data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#LONG_GAUGE} type.
   *
   * @return a new MetricData with a {@link MetricDataType#LONG_GAUGE} type.
   */
  public static MetricData createLongGauge(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      GaugeData data) {
    return ImmutableMetricData.create(
        resource,
        instrumentationScopeInfo,
        name,
        description,
        unit,
        MetricDataType.LONG_GAUGE,
        data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#DOUBLE_SUM} type.
   *
   * @return a new MetricData with a {@link MetricDataType#DOUBLE_SUM} type.
   */
  public static MetricData createDoubleSum(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      SumData data) {
    return ImmutableMetricData.create(
        resource,
        instrumentationScopeInfo,
        name,
        description,
        unit,
        MetricDataType.DOUBLE_SUM,
        data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#LONG_SUM} type.
   *
   * @return a new MetricData with a {@link MetricDataType#LONG_SUM} type.
   */
  public static MetricData createLongSum(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      SumData data) {
    return ImmutableMetricData.create(
        resource, instrumentationScopeInfo, name, description, unit, MetricDataType.LONG_SUM, data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#SUMMARY} type.
   *
   * @return a new MetricData with a {@link MetricDataType#SUMMARY} type.
   */
  public static MetricData createDoubleSummary(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      SummaryData data) {
    return ImmutableMetricData.create(
        resource, instrumentationScopeInfo, name, description, unit, MetricDataType.SUMMARY, data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#HISTOGRAM} type.
   *
   * @return a new MetricData with a {@link MetricDataType#HISTOGRAM} type.
   */
  public static MetricData createDoubleHistogram(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      HistogramData data) {
    return ImmutableMetricData.create(
        resource,
        instrumentationScopeInfo,
        name,
        description,
        unit,
        MetricDataType.HISTOGRAM,
        data);
  }

  /**
   * Returns a new MetricData with a {@link MetricDataType#EXPONENTIAL_HISTOGRAM} type.
   *
   * @return a new MetricData with a {@link MetricDataType#EXPONENTIAL_HISTOGRAM} type.
   */
  public static MetricData createExponentialHistogram(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      ExponentialHistogramData data) {
    return ImmutableMetricData.create(
        resource,
        instrumentationScopeInfo,
        name,
        description,
        unit,
        MetricDataType.EXPONENTIAL_HISTOGRAM,
        data);
  }

  // Visible for testing
  static ImmutableMetricData create(
      Resource resource,
      InstrumentationScopeInfo instrumentationScopeInfo,
      String name,
      String description,
      String unit,
      MetricDataType type,
      Data data) {
    return new AutoValue_ImmutableMetricData(
        resource, instrumentationScopeInfo, name, description, unit, type, data);
  }

  ImmutableMetricData() {}
}