Package io.opentelemetry.proto.metrics.v1

Interface HistogramDataPointOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HistogramDataPoint, HistogramDataPoint.Builder
    public interface HistogramDataPointOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

      • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

      • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

      • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

      • 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).
        repeated .opentelemetry.proto.common.v1.KeyValue attributes = 9;

      • getLabelsList

        @Deprecated
List<StringKeyValue> getLabelsList()
        Deprecated.
         Labels is deprecated and will be removed soon.
 1. Old senders and receivers that are not aware of this change will
 continue using the `labels` field.
 2. New senders, which are aware of this change MUST send only `attributes`.
 3. New receivers, which are aware of this change MUST convert this into
 `labels` by simply converting all int64 values into float.
 This field will be removed in ~3 months, on July 1, 2021.
        repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1 [deprecated = true];

      • getLabels

        @Deprecated
StringKeyValue getLabels​(int index)
        Deprecated.
         Labels is deprecated and will be removed soon.
 1. Old senders and receivers that are not aware of this change will
 continue using the `labels` field.
 2. New senders, which are aware of this change MUST send only `attributes`.
 3. New receivers, which are aware of this change MUST convert this into
 `labels` by simply converting all int64 values into float.
 This field will be removed in ~3 months, on July 1, 2021.
        repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1 [deprecated = true];

      • getLabelsCount

        @Deprecated
int getLabelsCount()
        Deprecated.
         Labels is deprecated and will be removed soon.
 1. Old senders and receivers that are not aware of this change will
 continue using the `labels` field.
 2. New senders, which are aware of this change MUST send only `attributes`.
 3. New receivers, which are aware of this change MUST convert this into
 `labels` by simply converting all int64 values into float.
 This field will be removed in ~3 months, on July 1, 2021.
        repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1 [deprecated = true];

      • getLabelsOrBuilderList

        @Deprecated
List<? extends StringKeyValueOrBuilder> getLabelsOrBuilderList()
        Deprecated.
         Labels is deprecated and will be removed soon.
 1. Old senders and receivers that are not aware of this change will
 continue using the `labels` field.
 2. New senders, which are aware of this change MUST send only `attributes`.
 3. New receivers, which are aware of this change MUST convert this into
 `labels` by simply converting all int64 values into float.
 This field will be removed in ~3 months, on July 1, 2021.
        repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1 [deprecated = true];

      • getLabelsOrBuilder

        @Deprecated
StringKeyValueOrBuilder getLabelsOrBuilder​(int index)
        Deprecated.
         Labels is deprecated and will be removed soon.
 1. Old senders and receivers that are not aware of this change will
 continue using the `labels` field.
 2. New senders, which are aware of this change MUST send only `attributes`.
 3. New receivers, which are aware of this change MUST convert this into
 `labels` by simply converting all int64 values into float.
 This field will be removed in ~3 months, on July 1, 2021.
        repeated .opentelemetry.proto.common.v1.StringKeyValue labels = 1 [deprecated = true];

      • 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;

      • 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;

      • 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 "count" fields in buckets if a
 histogram is provided.
        fixed64 count = 4;

      • 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
        double sum = 5;

      • getBucketCountsList

        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;

      • getBucketCountsCount

        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;

      • getBucketCounts

        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;

      • getExplicitBoundsList

        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;

      • getExplicitBoundsCount

        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;

      • getExplicitBounds

        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;

      • 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 = 8;

      • 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 = 8;

      • 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 = 8;

      • 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 = 8;

      • 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 = 8;

      • getFlags

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