impl_core/src/main/java/io/opencensus/implcore/temporary/metrics/MetricProducer.java

/*
 * Copyright 2018, OpenCensus 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.opencensus.implcore.temporary.metrics;

import io.opencensus.common.ExperimentalApi;
import io.opencensus.implcore.temporary.metrics.export.MetricProducerManager;
import java.util.Collection;

/**
 * A {@link io.opencensus.implcore.temporary.metrics.Metric} producer that can be registered for
 * exporting using {@link MetricProducerManager}.
 *
 * <p>All implementation MUST be thread-safe.
 */
@ExperimentalApi
public abstract class MetricProducer {

  /**
   * Returns a collection of produced {@link io.opencensus.implcore.temporary.metrics.Metric}s to be
   * exported.
   *
   * @return a collection of produced {@link io.opencensus.implcore.temporary.metrics.Metric}s to be
   *     exported.
   */
  public abstract Collection<Metric> getMetrics();
}