Package io.opentelemetry.proto.metrics.v1

Class ExponentialHistogramDataPoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExponentialHistogramDataPointOrBuilder, Serializable
public final class ExponentialHistogramDataPoint extends com.google.protobuf.GeneratedMessageV3 implements ExponentialHistogramDataPointOrBuilder
 ExponentialHistogramDataPoint is a single data point in a timeseries that describes the
 time-varying values of a ExponentialHistogram of double values. A ExponentialHistogram contains
 summary statistics for a population of values, it may optionally contain the
 distribution of those values across a set of buckets.
Protobuf type opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getAttributesList

      public 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;
      Specified by:
      getAttributesList in interface ExponentialHistogramDataPointOrBuilder

    • getAttributesOrBuilderList

      public 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;
      Specified by:
      getAttributesOrBuilderList in interface ExponentialHistogramDataPointOrBuilder

    • getAttributesCount

      public 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;
      Specified by:
      getAttributesCount in interface ExponentialHistogramDataPointOrBuilder

    • getAttributes

      public 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;
      Specified by:
      getAttributes in interface ExponentialHistogramDataPointOrBuilder

    • getAttributesOrBuilder

      public 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;
      Specified by:
      getAttributesOrBuilder in interface ExponentialHistogramDataPointOrBuilder

    • getStartTimeUnixNano

      public 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;
      Specified by:
      getStartTimeUnixNano in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The startTimeUnixNano.

    • getTimeUnixNano

      public 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;
      Specified by:
      getTimeUnixNano in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The timeUnixNano.

    • getCount

      public 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;
      Specified by:
      getCount in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The count.

    • hasSum

      public 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;
      Specified by:
      hasSum in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      Whether the sum field is set.

    • getSum

      public 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;
      Specified by:
      getSum in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The sum.

    • getScale

      public 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 (base^index) and
 less than or equal to (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;
      Specified by:
      getScale in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The scale.

    • getZeroCount

      public 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;
      Specified by:
      getZeroCount in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The zeroCount.

    • hasPositive

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

    • getPositive

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

    • getPositiveOrBuilder

      public ExponentialHistogramDataPoint.BucketsOrBuilder getPositiveOrBuilder()
       positive carries the positive range of exponential bucket counts.
      .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets positive = 8;
      Specified by:
      getPositiveOrBuilder in interface ExponentialHistogramDataPointOrBuilder

    • hasNegative

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

    • getNegative

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

    • getNegativeOrBuilder

      public ExponentialHistogramDataPoint.BucketsOrBuilder getNegativeOrBuilder()
       negative carries the negative range of exponential bucket counts.
      .opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint.Buckets negative = 9;
      Specified by:
      getNegativeOrBuilder in interface ExponentialHistogramDataPointOrBuilder

    • getFlags

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

    • getExemplarsList

      public 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;
      Specified by:
      getExemplarsList in interface ExponentialHistogramDataPointOrBuilder

    • getExemplarsOrBuilderList

      public 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;
      Specified by:
      getExemplarsOrBuilderList in interface ExponentialHistogramDataPointOrBuilder

    • getExemplarsCount

      public 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;
      Specified by:
      getExemplarsCount in interface ExponentialHistogramDataPointOrBuilder

    • getExemplars

      public 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;
      Specified by:
      getExemplars in interface ExponentialHistogramDataPointOrBuilder

    • getExemplarsOrBuilder

      public 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;
      Specified by:
      getExemplarsOrBuilder in interface ExponentialHistogramDataPointOrBuilder

    • hasMin

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

    • getMin

      public double getMin()
       min is the minimum value over (start_time, end_time].
      optional double min = 12;
      Specified by:
      getMin in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The min.

    • hasMax

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

    • getMax

      public double getMax()
       max is the maximum value over (start_time, end_time].
      optional double max = 13;
      Specified by:
      getMax in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The max.

    • getZeroThreshold

      public double getZeroThreshold()
       ZeroThreshold may be optionally set to convey the width of the zero
 region. Where the zero region is defined as the closed interval
 [-ZeroThreshold, ZeroThreshold].
 When ZeroThreshold is 0, zero count bucket stores values that cannot be
 expressed using the standard exponential formula as well as values that
 have been rounded to zero.
      double zero_threshold = 14;
      Specified by:
      getZeroThreshold in interface ExponentialHistogramDataPointOrBuilder
      Returns:
      The zeroThreshold.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExponentialHistogramDataPoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExponentialHistogramDataPoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExponentialHistogramDataPoint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExponentialHistogramDataPoint.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExponentialHistogramDataPoint.Builder newBuilder()

    • newBuilder

      public static ExponentialHistogramDataPoint.Builder newBuilder(ExponentialHistogramDataPoint prototype)

    • toBuilder

      public ExponentialHistogramDataPoint.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExponentialHistogramDataPoint.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExponentialHistogramDataPoint getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExponentialHistogramDataPoint> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExponentialHistogramDataPoint> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ExponentialHistogramDataPoint getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder