io.opentelemetry.metrics.BatchRecorder 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.metrics;

import javax.annotation.concurrent.ThreadSafe;

/**
 * Util class that can be use to atomically record measurements associated with a set of Metrics.
 *
 * This class is equivalent with individually calling record on every Measure, but has the
 * advantage that all these operations are recorded atomically and it is more efficient.
 */
@ThreadSafe
public interface BatchRecorder {
  /**
   * Associates the {@link LongValueRecorder} with the given value. Subsequent updates to the same
   * {@link LongValueRecorder} will overwrite the previous value.
   *
   * @param valueRecorder the {@link LongValueRecorder}.
   * @param value the value to be associated with {@code valueRecorder}.
   * @return this.
   * @since 0.1.0
   */
  BatchRecorder put(LongValueRecorder valueRecorder, long value);

  /**
   * Associates the {@link DoubleValueRecorder} with the given value. Subsequent updates to the same
   * {@link DoubleValueRecorder} will overwrite the previous value.
   *
   * @param valueRecorder the {@link DoubleValueRecorder}.
   * @param value the value to be associated with {@code valueRecorder}.
   * @return this.
   * @since 0.1.0
   */
  BatchRecorder put(DoubleValueRecorder valueRecorder, double value);

  /**
   * Associates the {@link LongCounter} with the given value. Subsequent updates to the same {@link
   * LongCounter} will overwrite the previous value.
   *
   * @param counter the {@link LongCounter}.
   * @param value the value to be associated with {@code counter}.
   * @return this.
   * @since 0.3.0
   */
  BatchRecorder put(LongCounter counter, long value);

  /**
   * Associates the {@link DoubleCounter} with the given value. Subsequent updates to the same
   * {@link DoubleCounter} will overwrite the previous value.
   *
   * @param counter the {@link DoubleCounter}.
   * @param value the value to be associated with {@code counter}.
   * @return this.
   * @since 0.3.0
   */
  BatchRecorder put(DoubleCounter counter, double value);

  /**
   * Associates the {@link LongUpDownCounter} with the given value. Subsequent updates to the same
   * {@link LongCounter} will overwrite the previous value.
   *
   * @param upDownCounter the {@link LongCounter}.
   * @param value the value to be associated with {@code counter}.
   * @return this.
   * @since 0.5.0
   */
  BatchRecorder put(LongUpDownCounter upDownCounter, long value);

  /**
   * Associates the {@link DoubleUpDownCounter} with the given value. Subsequent updates to the same
   * {@link DoubleCounter} will overwrite the previous value.
   *
   * @param upDownCounter the {@link DoubleCounter}.
   * @param value the value to be associated with {@code counter}.
   * @return this.
   * @since 0.5.0
   */
  BatchRecorder put(DoubleUpDownCounter upDownCounter, double value);

  /**
   * Records all of measurements at the same time.
   *
   * This method records all measurements every time it is called, so make sure it is not called
   * twice if not needed.
   *
   * @since 0.1.0
   */
  void record();
}