Module io.helidon.metrics.api
Package io.helidon.metrics.api

Interface Bucket

All Superinterfaces:
Wrapper
public interface Bucket extends Wrapper
Representation of a histogram bucket, including the boundary value and the count of observations in that bucket.

The boundary value is an upper bound on the observation values that can occupy the bucket. That is, an observation occupies a bucket if its value is less than or equal to the bucket's boundary value.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    boundary()
    Returns the bucket boundary.
    double
    boundary(TimeUnit unit)
    Returns the bucket boundary interpreted as a time in nanoseconds and expressed in the specified TimeUnit.
    long
    count()
    Returns the number of observations in the bucket.

    Methods inherited from interface io.helidon.metrics.api.Wrapper

    unwrap

  • Method Details

    • boundary

      double boundary()
      Returns the bucket boundary.
      Returns:
      bucket boundary value

    • boundary

      double boundary(TimeUnit unit)
      Returns the bucket boundary interpreted as a time in nanoseconds and expressed in the specified TimeUnit.
      Parameters:
      unit - time unit in which to express the bucket boundary
      Returns:
      bucket boundary value

    • count

      long count()
      Returns the number of observations in the bucket.
      Returns:
      observation count for the bucket