io.opentelemetry.sdk.metrics.export.MetricExporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lightstep-opentelemetry-auto-exporter Show documentation

Lightstep OpenTelemetry Auto Exporter

The newest version!

/*
 * Copyright 2019, 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
 *
 *     http://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.
 */

package io.opentelemetry.sdk.metrics.export;

import io.opentelemetry.sdk.metrics.data.MetricData;
import java.util.Collection;

/**
 * {@code MetricExporter} is the interface that all "push based" metric libraries should use to
 * export metrics to the OpenTelemetry exporters.
 *
 * All OpenTelemetry exporters should allow access to a {@code MetricExporter} instance.
 *
 * @since 0.1.0
 */
public interface MetricExporter {

  /**
   * The possible results for the export method.
   *
   * @since 0.1.0
   */
  // TODO: extract this enum and unify it with SpanExporter.ResultCode
  enum ResultCode {
    /** The export operation finished successfully. */
    SUCCESS,

    /** The export operation finished with an error. */
    FAILURE
  }

  /**
   * Exports the collection of given {@link MetricData}.
   *
   * @param metrics the collection of {@link MetricData} to be exported.
   * @return the result of the export.
   * @since 0.1.0
   */
  ResultCode export(Collection metrics);

  /**
   * Exports the collection of {@link MetricData} that have not yet been exported.
   *
   * @return the result of the flush.
   * @since 0.4.0
   */
  ResultCode flush();

  /** Called when the associated IntervalMetricReader is shutdown. */
  void shutdown();
}