Package io.opentelemetry.proto.metrics.v1

Interface ExponentialHistogramDataPointOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      KeyValue getAttributes​(int index)
      The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
      int getAttributesCount()
      The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
      List<KeyValue> getAttributesList()
      The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
      KeyValueOrBuilder getAttributesOrBuilder​(int index)
      The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
      List<? extends KeyValueOrBuilder> getAttributesOrBuilderList()
      The set of key/value pairs that uniquely identify the timeseries from where this point belongs.
      long getCount()
      count is the number of values in the population.
      Exemplar getExemplars​(int index)
      (Optional) List of exemplars collected from measurements that were used to form the data point
      int getExemplarsCount()
      (Optional) List of exemplars collected from measurements that were used to form the data point
      List<Exemplar> getExemplarsList()
      (Optional) List of exemplars collected from measurements that were used to form the data point
      ExemplarOrBuilder getExemplarsOrBuilder​(int index)
      (Optional) List of exemplars collected from measurements that were used to form the data point
      List<? extends ExemplarOrBuilder> getExemplarsOrBuilderList()
      (Optional) List of exemplars collected from measurements that were used to form the data point
      int getFlags()
      Flags that apply to this specific data point.
      double getMax()
      max is the maximum value over (start_time, end_time].
      double getMin()
      min is the minimum value over (start_time, end_time].
      ExponentialHistogramDataPoint.Buckets getNegative()
      negative carries the negative range of exponential bucket counts.
      ExponentialHistogramDataPoint.BucketsOrBuilder getNegativeOrBuilder()
      negative carries the negative range of exponential bucket counts.
      ExponentialHistogramDataPoint.Buckets getPositive()
      positive carries the positive range of exponential bucket counts.
      ExponentialHistogramDataPoint.BucketsOrBuilder getPositiveOrBuilder()
      positive carries the positive range of exponential bucket counts.
      int getScale()
      scale describes the resolution of the histogram.
      long getStartTimeUnixNano()
      StartTimeUnixNano is optional but strongly encouraged, see the the detailed comments above Metric.
      double getSum()
      sum of the values in the population.
      long getTimeUnixNano()
      TimeUnixNano is required, see the detailed comments above Metric.
      long getZeroCount()
      zero_count is the count of values that are either exactly zero or within the region considered zero by the instrumentation at the tolerated degree of precision.
      boolean hasMax()
      max is the maximum value over (start_time, end_time].
      boolean hasMin()
      min is the minimum value over (start_time, end_time].
      boolean hasNegative()
      negative carries the negative range of exponential bucket counts.
      boolean hasPositive()
      positive carries the positive range of exponential bucket counts.
      boolean hasSum()
      sum of the values in the population.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getAttributesList

        List<KeyValue> getAttributesList()
         The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

      • getAttributes

        KeyValue getAttributes​(int index)
         The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

      • getAttributesCount

        int getAttributesCount()
         The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

      • getAttributesOrBuilderList

        List<? extends KeyValueOrBuilder> getAttributesOrBuilderList()
         The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

      • getAttributesOrBuilder

        KeyValueOrBuilder getAttributesOrBuilder​(int index)
         The set of key/value pairs that uniquely identify the timeseries from
 where this point belongs. The list may be empty (may contain 0 elements).
 Attribute keys MUST be unique (it is not allowed to have more than one
 attribute with the same key).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 1;

      • getStartTimeUnixNano

        long getStartTimeUnixNano()
         StartTimeUnixNano is optional but strongly encouraged, see the
 the detailed comments above Metric.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
 1970.
        fixed64 start_time_unix_nano = 2;
        Returns:
        The startTimeUnixNano.

      • getTimeUnixNano

        long getTimeUnixNano()
         TimeUnixNano is required, see the detailed comments above Metric.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
 1970.
        fixed64 time_unix_nano = 3;
        Returns:
        The timeUnixNano.

      • getCount

        long getCount()
         count is the number of values in the population. Must be
 non-negative. This value must be equal to the sum of the "bucket_counts"
 values in the positive and negative Buckets plus the "zero_count" field.
        fixed64 count = 4;
        Returns:
        The count.

      • hasSum

        boolean hasSum()
         sum of the values in the population. If count is zero then this field
 must be zero.
 Note: Sum should only be filled out when measuring non-negative discrete
 events, and is assumed to be monotonic over the values of these events.
 Negative events *can* be recorded, but sum should not be filled out when
 doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
 see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
        optional double sum = 5;
        Returns:
        Whether the sum field is set.

      • getSum

        double getSum()
         sum of the values in the population. If count is zero then this field
 must be zero.
 Note: Sum should only be filled out when measuring non-negative discrete
 events, and is assumed to be monotonic over the values of these events.
 Negative events *can* be recorded, but sum should not be filled out when
 doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
 see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
        optional double sum = 5;
        Returns:
        The sum.

      • getScale

        int getScale()
         scale describes the resolution of the histogram.  Boundaries are
 located at powers of the base, where:
   base = (2^(2^-scale))
 The histogram bucket identified by `index`, a signed integer,
 contains values that are greater than or equal to (base^index) and
 less than (base^(index+1)).
 The positive and negative ranges of the histogram are expressed
 separately.  Negative values are mapped by their absolute value
 into the negative range using the same scale as the positive range.
 scale is not restricted by the protocol, as the permissible
 values depend on the range of the data.
        sint32 scale = 6;
        Returns:
        The scale.

      • getZeroCount

        long getZeroCount()
         zero_count is the count of values that are either exactly zero or
 within the region considered zero by the instrumentation at the
 tolerated degree of precision.  This bucket stores values that
 cannot be expressed using the standard exponential formula as
 well as values that have been rounded to zero.
 Implementations MAY consider the zero bucket to have probability
 mass equal to (zero_count / count).
        fixed64 zero_count = 7;
        Returns:
        The zeroCount.

      • hasPositive

        boolean hasPositive()
         positive carries the positive range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;
        Returns:
        Whether the positive field is set.

      • getPositive

        ExponentialHistogramDataPoint.Buckets getPositive()
         positive carries the positive range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;
        Returns:
        The positive.

      • getPositiveOrBuilder

        ExponentialHistogramDataPoint.BucketsOrBuilder getPositiveOrBuilder()
         positive carries the positive range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;

      • hasNegative

        boolean hasNegative()
         negative carries the negative range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;
        Returns:
        Whether the negative field is set.

      • getNegative

        ExponentialHistogramDataPoint.Buckets getNegative()
         negative carries the negative range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;
        Returns:
        The negative.

      • getNegativeOrBuilder

        ExponentialHistogramDataPoint.BucketsOrBuilder getNegativeOrBuilder()
         negative carries the negative range of exponential bucket counts.
        .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;

      • getFlags

        int getFlags()
         Flags that apply to this specific data point.  See DataPointFlags
 for the available flags and their meaning.
        uint32 flags = 10;
        Returns:
        The flags.

      • getExemplarsList

        List<Exemplar> getExemplarsList()
         (Optional) List of exemplars collected from
 measurements that were used to form the data point
        repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

      • getExemplars

        Exemplar getExemplars​(int index)
         (Optional) List of exemplars collected from
 measurements that were used to form the data point
        repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

      • getExemplarsCount

        int getExemplarsCount()
         (Optional) List of exemplars collected from
 measurements that were used to form the data point
        repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

      • getExemplarsOrBuilderList

        List<? extends ExemplarOrBuilder> getExemplarsOrBuilderList()
         (Optional) List of exemplars collected from
 measurements that were used to form the data point
        repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

      • getExemplarsOrBuilder

        ExemplarOrBuilder getExemplarsOrBuilder​(int index)
         (Optional) List of exemplars collected from
 measurements that were used to form the data point
        repeated .opentelemetry.proto.metrics.v1.Exemplar exemplars = 11;

      • hasMin

        boolean hasMin()
         min is the minimum value over (start_time, end_time].
        optional double min = 12;
        Returns:
        Whether the min field is set.

      • getMin

        double getMin()
         min is the minimum value over (start_time, end_time].
        optional double min = 12;
        Returns:
        The min.

      • hasMax

        boolean hasMax()
         max is the maximum value over (start_time, end_time].
        optional double max = 13;
        Returns:
        Whether the max field is set.

      • getMax

        double getMax()
         max is the maximum value over (start_time, end_time].
        optional double max = 13;
        Returns:
        The max.