Package io.opentelemetry.proto.metrics.v1

Class HistogramDataPoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HistogramDataPointOrBuilder, Serializable
    public final class HistogramDataPoint
extends com.google.protobuf.GeneratedMessageV3
implements HistogramDataPointOrBuilder
     HistogramDataPoint is a single data point in a timeseries that describes the
 time-varying values of a Histogram. A Histogram contains summary statistics
 for a population of values, it may optionally contain the distribution of
 those values across a set of buckets.
 If the histogram contains the distribution of values, then both
 "explicit_bounds" and "bucket counts" fields must be defined.
 If the histogram does not contain the distribution of values, then both
 "explicit_bounds" and "bucket_counts" must be omitted and only "count" and
 "sum" are known.
    Protobuf type opentelemetry.proto.metrics.v1.HistogramDataPoint
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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 = 9;
        Specified by:
        getAttributesList in interface HistogramDataPointOrBuilder

      • 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 = 9;
        Specified by:
        getAttributesOrBuilderList in interface HistogramDataPointOrBuilder

      • 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 = 9;
        Specified by:
        getAttributesCount in interface HistogramDataPointOrBuilder

      • 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 = 9;
        Specified by:
        getAttributes in interface HistogramDataPointOrBuilder

      • 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 = 9;
        Specified by:
        getAttributesOrBuilder in interface HistogramDataPointOrBuilder

      • 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 HistogramDataPointOrBuilder
        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 HistogramDataPointOrBuilder
        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 "count" fields in buckets if a
 histogram is provided.
        fixed64 count = 4;
        Specified by:
        getCount in interface HistogramDataPointOrBuilder
        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 HistogramDataPointOrBuilder
        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 HistogramDataPointOrBuilder
        Returns:
        The sum.

      • getBucketCountsList

        public List<Long> getBucketCountsList()
         bucket_counts is an optional field contains the count values of histogram
 for each bucket.
 The sum of the bucket_counts must equal the value in the count field.
 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
        repeated fixed64 bucket_counts = 6;
        Specified by:
        getBucketCountsList in interface HistogramDataPointOrBuilder
        Returns:
        A list containing the bucketCounts.

      • getBucketCountsCount

        public int getBucketCountsCount()
         bucket_counts is an optional field contains the count values of histogram
 for each bucket.
 The sum of the bucket_counts must equal the value in the count field.
 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
        repeated fixed64 bucket_counts = 6;
        Specified by:
        getBucketCountsCount in interface HistogramDataPointOrBuilder
        Returns:
        The count of bucketCounts.

      • getBucketCounts

        public long getBucketCounts​(int index)
         bucket_counts is an optional field contains the count values of histogram
 for each bucket.
 The sum of the bucket_counts must equal the value in the count field.
 The number of elements in bucket_counts array must be by one greater than
 the number of elements in explicit_bounds array.
        repeated fixed64 bucket_counts = 6;
        Specified by:
        getBucketCounts in interface HistogramDataPointOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The bucketCounts at the given index.

      • getExplicitBoundsList

        public List<Double> getExplicitBoundsList()
         explicit_bounds specifies buckets with explicitly defined bounds for values.
 The boundaries for bucket at index i are:
 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
 The values in the explicit_bounds array must be strictly increasing.
 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
        repeated double explicit_bounds = 7;
        Specified by:
        getExplicitBoundsList in interface HistogramDataPointOrBuilder
        Returns:
        A list containing the explicitBounds.

      • getExplicitBoundsCount

        public int getExplicitBoundsCount()
         explicit_bounds specifies buckets with explicitly defined bounds for values.
 The boundaries for bucket at index i are:
 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
 The values in the explicit_bounds array must be strictly increasing.
 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
        repeated double explicit_bounds = 7;
        Specified by:
        getExplicitBoundsCount in interface HistogramDataPointOrBuilder
        Returns:
        The count of explicitBounds.

      • getExplicitBounds

        public double getExplicitBounds​(int index)
         explicit_bounds specifies buckets with explicitly defined bounds for values.
 The boundaries for bucket at index i are:
 (-infinity, explicit_bounds[i]] for i == 0
 (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < size(explicit_bounds)
 (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
 The values in the explicit_bounds array must be strictly increasing.
 Histogram buckets are inclusive of their upper boundary, except the last
 bucket where the boundary is at infinity. This format is intentionally
 compatible with the OpenMetrics histogram definition.
        repeated double explicit_bounds = 7;
        Specified by:
        getExplicitBounds in interface HistogramDataPointOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The explicitBounds at the given index.

      • 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 = 8;
        Specified by:
        getExemplarsList in interface HistogramDataPointOrBuilder

      • 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 = 8;
        Specified by:
        getExemplarsCount in interface HistogramDataPointOrBuilder

      • 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 = 8;
        Specified by:
        getExemplars in interface HistogramDataPointOrBuilder

      • 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 = 8;
        Specified by:
        getExemplarsOrBuilder in interface HistogramDataPointOrBuilder

      • 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 HistogramDataPointOrBuilder
        Returns:
        The flags.

      • hasMin

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

      • getMin

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

      • hasMax

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

      • getMax

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

      • 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 HistogramDataPoint parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<HistogramDataPoint> 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 HistogramDataPoint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder