Package io.prometheus.client

Class Metrics.Histogram

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Metrics.HistogramOrBuilder, Serializable
    Enclosing class:
    Metrics
    public static final class Metrics.Histogram
extends com.google.protobuf.GeneratedMessageV3
implements Metrics.HistogramOrBuilder
    Protobuf type io.prometheus.client.Histogram
    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

      • hasSampleCount

        public boolean hasSampleCount()
        optional uint64 sample_count = 1;
        Specified by:
        hasSampleCount in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the sampleCount field is set.

      • hasSampleCountFloat

        public boolean hasSampleCountFloat()
         Overrides sample_count if > 0.
        optional double sample_count_float = 4;
        Specified by:
        hasSampleCountFloat in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the sampleCountFloat field is set.

      • getSampleCountFloat

        public double getSampleCountFloat()
         Overrides sample_count if > 0.
        optional double sample_count_float = 4;
        Specified by:
        getSampleCountFloat in interface Metrics.HistogramOrBuilder
        Returns:
        The sampleCountFloat.

      • hasSampleSum

        public boolean hasSampleSum()
        optional double sample_sum = 2;
        Specified by:
        hasSampleSum in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the sampleSum field is set.

      • getBucketCount

        public int getBucketCount()
         Buckets for the conventional histogram.
        repeated .io.prometheus.client.Bucket bucket = 3;
        Specified by:
        getBucketCount in interface Metrics.HistogramOrBuilder

      • hasSchema

        public boolean hasSchema()
         schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
 They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
 then each power of two is divided into 2^n logarithmic buckets.
 Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
 In the future, more bucket schemas may be added using numbers < -4 or > 8.
        optional sint32 schema = 5;
        Specified by:
        hasSchema in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the schema field is set.

      • getSchema

        public int getSchema()
         schema defines the bucket schema. Currently, valid numbers are -4 <= n <= 8.
 They are all for base-2 bucket schemas, where 1 is a bucket boundary in each case, and
 then each power of two is divided into 2^n logarithmic buckets.
 Or in other words, each bucket boundary is the previous boundary times 2^(2^-n).
 In the future, more bucket schemas may be added using numbers < -4 or > 8.
        optional sint32 schema = 5;
        Specified by:
        getSchema in interface Metrics.HistogramOrBuilder
        Returns:
        The schema.

      • hasZeroThreshold

        public boolean hasZeroThreshold()
         Breadth of the zero bucket.
        optional double zero_threshold = 6;
        Specified by:
        hasZeroThreshold in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the zeroThreshold field is set.

      • getZeroThreshold

        public double getZeroThreshold()
         Breadth of the zero bucket.
        optional double zero_threshold = 6;
        Specified by:
        getZeroThreshold in interface Metrics.HistogramOrBuilder
        Returns:
        The zeroThreshold.

      • hasZeroCount

        public boolean hasZeroCount()
         Count in zero bucket.
        optional uint64 zero_count = 7;
        Specified by:
        hasZeroCount in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the zeroCount field is set.

      • getZeroCount

        public long getZeroCount()
         Count in zero bucket.
        optional uint64 zero_count = 7;
        Specified by:
        getZeroCount in interface Metrics.HistogramOrBuilder
        Returns:
        The zeroCount.

      • hasZeroCountFloat

        public boolean hasZeroCountFloat()
         Overrides sb_zero_count if > 0.
        optional double zero_count_float = 8;
        Specified by:
        hasZeroCountFloat in interface Metrics.HistogramOrBuilder
        Returns:
        Whether the zeroCountFloat field is set.

      • getZeroCountFloat

        public double getZeroCountFloat()
         Overrides sb_zero_count if > 0.
        optional double zero_count_float = 8;
        Specified by:
        getZeroCountFloat in interface Metrics.HistogramOrBuilder
        Returns:
        The zeroCountFloat.

      • getNegativeSpanCount

        public int getNegativeSpanCount()
         Negative buckets for the native histogram.
        repeated .io.prometheus.client.BucketSpan negative_span = 9;
        Specified by:
        getNegativeSpanCount in interface Metrics.HistogramOrBuilder

      • getNegativeDeltaList

        public List<Long> getNegativeDeltaList()
         Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 negative_delta = 10;
        Specified by:
        getNegativeDeltaList in interface Metrics.HistogramOrBuilder
        Returns:
        A list containing the negativeDelta.

      • getNegativeDeltaCount

        public int getNegativeDeltaCount()
         Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 negative_delta = 10;
        Specified by:
        getNegativeDeltaCount in interface Metrics.HistogramOrBuilder
        Returns:
        The count of negativeDelta.

      • getNegativeDelta

        public long getNegativeDelta​(int index)
         Use either "negative_delta" or "negative_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 negative_delta = 10;
        Specified by:
        getNegativeDelta in interface Metrics.HistogramOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The negativeDelta at the given index.

      • getNegativeCountCount

        public int getNegativeCountCount()
         Absolute count of each bucket.
        repeated double negative_count = 11;
        Specified by:
        getNegativeCountCount in interface Metrics.HistogramOrBuilder
        Returns:
        The count of negativeCount.

      • getNegativeCount

        public double getNegativeCount​(int index)
         Absolute count of each bucket.
        repeated double negative_count = 11;
        Specified by:
        getNegativeCount in interface Metrics.HistogramOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The negativeCount at the given index.

      • getPositiveSpanCount

        public int getPositiveSpanCount()
         Positive buckets for the native histogram.
        repeated .io.prometheus.client.BucketSpan positive_span = 12;
        Specified by:
        getPositiveSpanCount in interface Metrics.HistogramOrBuilder

      • getPositiveDeltaList

        public List<Long> getPositiveDeltaList()
         Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 positive_delta = 13;
        Specified by:
        getPositiveDeltaList in interface Metrics.HistogramOrBuilder
        Returns:
        A list containing the positiveDelta.

      • getPositiveDeltaCount

        public int getPositiveDeltaCount()
         Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 positive_delta = 13;
        Specified by:
        getPositiveDeltaCount in interface Metrics.HistogramOrBuilder
        Returns:
        The count of positiveDelta.

      • getPositiveDelta

        public long getPositiveDelta​(int index)
         Use either "positive_delta" or "positive_count", the former for
 regular histograms with integer counts, the latter for float
 histograms.
        repeated sint64 positive_delta = 13;
        Specified by:
        getPositiveDelta in interface Metrics.HistogramOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The positiveDelta at the given index.

      • getPositiveCountCount

        public int getPositiveCountCount()
         Absolute count of each bucket.
        repeated double positive_count = 14;
        Specified by:
        getPositiveCountCount in interface Metrics.HistogramOrBuilder
        Returns:
        The count of positiveCount.

      • getPositiveCount

        public double getPositiveCount​(int index)
         Absolute count of each bucket.
        repeated double positive_count = 14;
        Specified by:
        getPositiveCount in interface Metrics.HistogramOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The positiveCount at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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