io.opentelemetry.api.metrics.DoubleHistogramBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of polaris-all Show documentation

All in one project for polaris-java

There is a newer version: 2.0.1.0-RC1

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

package io.opentelemetry.api.metrics;

import java.util.List;

/**
 * Builder class for {@link DoubleHistogram}.
 *
 * @since 1.10.0
 */
public interface DoubleHistogramBuilder {

  /**
   * Sets the description for this instrument.
   *
   * @param description The description.
   * @see Instrument
   *     Description
   */
  DoubleHistogramBuilder setDescription(String description);

  /**
   * Sets the unit of measure for this instrument.
   *
   * @param unit The unit. Instrument units must be 63 or fewer ASCII characters.
   * @see Instrument
   *     Unit
   */
  DoubleHistogramBuilder setUnit(String unit);

  /**
   * Set the explicit bucket buckets boundaries advice, which suggests the recommended set of
   * explicit bucket boundaries for this histogram.
   *
   * @param bucketBoundaries The explicit bucket boundaries advice.
   * @see Explicit
   *     bucket boundaries advisory parameter
   * @since 1.32.0
   */
  default DoubleHistogramBuilder setExplicitBucketBoundariesAdvice(List bucketBoundaries) {
    return this;
  }

  /** Sets the Counter for recording {@code long} values. */
  LongHistogramBuilder ofLongs();

  /**
   * Builds and returns a Histogram instrument with the configuration.
   *
   * @return The Histogram instrument.
   */
  DoubleHistogram build();
}