Package io.opentelemetry.api.metrics

Interface LongHistogram

@ThreadSafe public interface LongHistogram
A Histogram instrument that records long values.
Since:
1.10.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isEnabled()
    Returns true if the histogram is enabled.
    void
    record(long value)
    Records a value.
    void
    record(long value, Attributes attributes)
    Records a value with a set of attributes.
    void
    record(long value, Attributes attributes, io.opentelemetry.context.Context context)
    Records a value with a set of attributes.

  • Method Details

    • isEnabled

      default boolean isEnabled()
      Returns true if the histogram is enabled.

      This allows callers to avoid unnecessary compute when nothing is consuming the data. Because the response is subject to change over the application, callers should call this before each call to record(long), record(long, Attributes), or record(long, Attributes, Context).

      Since:
      1.61.0

    • record

      void record(long value)
      Records a value.

      Note: This may use Context.current() to pull the context associated with this measurement.

      Parameters:
      value - The amount of the measurement. MUST be non-negative.

    • record

      void record(long value, Attributes attributes)
      Records a value with a set of attributes.

      Note: This may use Context.current() to pull the context associated with this measurement.

      Parameters:
      value - The amount of the measurement. MUST be non-negative.
      attributes - A set of attributes to associate with the value.

    • record

      void record(long value, Attributes attributes, io.opentelemetry.context.Context context)
      Records a value with a set of attributes.
      Parameters:
      value - The amount of the measurement. MUST be non-negative.
      attributes - A set of attributes to associate with the value.
      context - The explicit context to associate with this measurement.