Package io.opentelemetry.proto.metrics.v1

Class Metric

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetricOrBuilder, Serializable
    public final class Metric
extends com.google.protobuf.GeneratedMessageV3
implements MetricOrBuilder
     Defines a Metric which has one or more timeseries.  The following is a
 brief summary of the Metric data model.  For more details, see:
   https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/datamodel.md
 The data model and relation between entities is shown in the
 diagram below. Here, "DataPoint" is the term used to refer to any
 one of the specific data point value types, and "points" is the term used
 to refer to any one of the lists of points contained in the Metric.
 - Metric is composed of a metadata and data.
 - Metadata part contains a name, description, unit.
 - Data is one of the possible types (Sum, Gauge, Histogram, Summary).
 - DataPoint contains timestamps, attributes, and one of the possible value type
   fields.
     Metric
  +------------+
  |name        |
  |description |
  |unit        |     +------------------------------------+
  |data        |---> |Gauge, Sum, Histogram, Summary, ... |
  +------------+     +------------------------------------+
    Data [One of Gauge, Sum, Histogram, Summary, ...]
  +-----------+
  |...        |  // Metadata about the Data.
  |points     |--+
  +-----------+  |
                 |      +---------------------------+
                 |      |DataPoint 1                |
                 v      |+------+------+   +------+ |
              +-----+   ||label |label |...|label | |
              |  1  |-->||value1|value2|...|valueN| |
              +-----+   |+------+------+   +------+ |
              |  .  |   |+-----+                    |
              |  .  |   ||value|                    |
              |  .  |   |+-----+                    |
              |  .  |   +---------------------------+
              |  .  |                   .
              |  .  |                   .
              |  .  |                   .
              |  .  |   +---------------------------+
              |  .  |   |DataPoint M                |
              +-----+   |+------+------+   +------+ |
              |  M  |-->||label |label |...|label | |
              +-----+   ||value1|value2|...|valueN| |
                        |+------+------+   +------+ |
                        |+-----+                    |
                        ||value|                    |
                        |+-----+                    |
                        +---------------------------+
 Each distinct type of DataPoint represents the output of a specific
 aggregation function, the result of applying the DataPoint's
 associated function of to one or more measurements.
 All DataPoint types have three common fields:
 - Attributes includes key-value pairs associated with the data point
 - TimeUnixNano is required, set to the end time of the aggregation
 - StartTimeUnixNano is optional, but strongly encouraged for DataPoints
   having an AggregationTemporality field, as discussed below.
 Both TimeUnixNano and StartTimeUnixNano values are expressed as
 UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
 # TimeUnixNano
 This field is required, having consistent interpretation across
 DataPoint types.  TimeUnixNano is the moment corresponding to when
 the data point's aggregate value was captured.
 Data points with the 0 value for TimeUnixNano SHOULD be rejected
 by consumers.
 # StartTimeUnixNano
 StartTimeUnixNano in general allows detecting when a sequence of
 observations is unbroken.  This field indicates to consumers the
 start time for points with cumulative and delta
 AggregationTemporality, and it should be included whenever possible
 to support correct rate calculation.  Although it may be omitted
 when the start time is truly unknown, setting StartTimeUnixNano is
 strongly encouraged.
    Protobuf type opentelemetry.proto.metrics.v1.Metric
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Metric.Builder
      Defines a Metric which has one or more timeseries.
      static class  Metric.DataCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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

      • getName

        public String getName()
         name of the metric, including its DNS name prefix. It must be unique.
        string name = 1;
        Specified by:
        getName in interface MetricOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         name of the metric, including its DNS name prefix. It must be unique.
        string name = 1;
        Specified by:
        getNameBytes in interface MetricOrBuilder
        Returns:
        The bytes for name.

      • getDescription

        public String getDescription()
         description of the metric, which can be used in documentation.
        string description = 2;
        Specified by:
        getDescription in interface MetricOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         description of the metric, which can be used in documentation.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface MetricOrBuilder
        Returns:
        The bytes for description.

      • getUnit

        public String getUnit()
         unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.
        string unit = 3;
        Specified by:
        getUnit in interface MetricOrBuilder
        Returns:
        The unit.

      • getUnitBytes

        public com.google.protobuf.ByteString getUnitBytes()
         unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.
        string unit = 3;
        Specified by:
        getUnitBytes in interface MetricOrBuilder
        Returns:
        The bytes for unit.

      • hasGauge

        public boolean hasGauge()
        .opentelemetry.proto.metrics.v1.Gauge gauge = 5;
        Specified by:
        hasGauge in interface MetricOrBuilder
        Returns:
        Whether the gauge field is set.

      • getGauge

        public Gauge getGauge()
        .opentelemetry.proto.metrics.v1.Gauge gauge = 5;
        Specified by:
        getGauge in interface MetricOrBuilder
        Returns:
        The gauge.

      • hasSum

        public boolean hasSum()
        .opentelemetry.proto.metrics.v1.Sum sum = 7;
        Specified by:
        hasSum in interface MetricOrBuilder
        Returns:
        Whether the sum field is set.

      • getSum

        public Sum getSum()
        .opentelemetry.proto.metrics.v1.Sum sum = 7;
        Specified by:
        getSum in interface MetricOrBuilder
        Returns:
        The sum.

      • hasHistogram

        public boolean hasHistogram()
        .opentelemetry.proto.metrics.v1.Histogram histogram = 9;
        Specified by:
        hasHistogram in interface MetricOrBuilder
        Returns:
        Whether the histogram field is set.

      • getHistogram

        public Histogram getHistogram()
        .opentelemetry.proto.metrics.v1.Histogram histogram = 9;
        Specified by:
        getHistogram in interface MetricOrBuilder
        Returns:
        The histogram.

      • hasExponentialHistogram

        public boolean hasExponentialHistogram()
        .opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;
        Specified by:
        hasExponentialHistogram in interface MetricOrBuilder
        Returns:
        Whether the exponentialHistogram field is set.

      • hasSummary

        public boolean hasSummary()
        .opentelemetry.proto.metrics.v1.Summary summary = 11;
        Specified by:
        hasSummary in interface MetricOrBuilder
        Returns:
        Whether the summary field is set.

      • getSummary

        public Summary getSummary()
        .opentelemetry.proto.metrics.v1.Summary summary = 11;
        Specified by:
        getSummary in interface MetricOrBuilder
        Returns:
        The summary.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Metric getDefaultInstance()

      • parser

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

      • getParserForType

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