Class Metric
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.opentelemetry.proto.metrics.v1.Metric
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,MetricOrBuilder,Serializable
@Generated
public final class Metric
extends com.google.protobuf.GeneratedMessage
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/data-model.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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDefines a Metric which has one or more timeseries.static enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic Metricdescription of the metric, which can be used in documentation.com.google.protobuf.ByteStringdescription of the metric, which can be used in documentation.static final com.google.protobuf.Descriptors.Descriptor.opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;.opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;getGauge().opentelemetry.proto.metrics.v1.Gauge gauge = 5;.opentelemetry.proto.metrics.v1.Gauge gauge = 5;.opentelemetry.proto.metrics.v1.Histogram histogram = 9;.opentelemetry.proto.metrics.v1.Histogram histogram = 9;getMetadata(int index) Additional metadata attributes that describe the metric.intAdditional metadata attributes that describe the metric.Additional metadata attributes that describe the metric.getMetadataOrBuilder(int index) Additional metadata attributes that describe the metric.List<? extends KeyValueOrBuilder>Additional metadata attributes that describe the metric.getName()name of the metric.com.google.protobuf.ByteStringname of the metric.com.google.protobuf.Parser<Metric>intgetSum().opentelemetry.proto.metrics.v1.Sum sum = 7;.opentelemetry.proto.metrics.v1.Summary summary = 11;.opentelemetry.proto.metrics.v1.Summary summary = 11;.opentelemetry.proto.metrics.v1.Sum sum = 7;getUnit()unit in which the metric value is reported.com.google.protobuf.ByteStringunit in which the metric value is reported.boolean.opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;booleanhasGauge().opentelemetry.proto.metrics.v1.Gauge gauge = 5;inthashCode()boolean.opentelemetry.proto.metrics.v1.Histogram histogram = 9;booleanhasSum().opentelemetry.proto.metrics.v1.Sum sum = 7;boolean.opentelemetry.proto.metrics.v1.Summary summary = 11;protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Metric.Builderstatic Metric.BuildernewBuilder(Metric prototype) protected Metric.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static MetricparseDelimitedFrom(InputStream input) static MetricparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricparseFrom(byte[] data) static MetricparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricparseFrom(com.google.protobuf.ByteString data) static MetricparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricparseFrom(com.google.protobuf.CodedInputStream input) static MetricparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricparseFrom(InputStream input) static MetricparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static MetricparseFrom(ByteBuffer data) static MetricparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Metric>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER- See Also:
-
GAUGE_FIELD_NUMBER
public static final int GAUGE_FIELD_NUMBER- See Also:
-
SUM_FIELD_NUMBER
public static final int SUM_FIELD_NUMBER- See Also:
-
HISTOGRAM_FIELD_NUMBER
public static final int HISTOGRAM_FIELD_NUMBER- See Also:
-
EXPONENTIAL_HISTOGRAM_FIELD_NUMBER
public static final int EXPONENTIAL_HISTOGRAM_FIELD_NUMBER- See Also:
-
SUMMARY_FIELD_NUMBER
public static final int SUMMARY_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getDataCase
- Specified by:
getDataCasein interfaceMetricOrBuilder
-
getName
name of the metric.
string name = 1;- Specified by:
getNamein interfaceMetricOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()name of the metric.
string name = 1;- Specified by:
getNameBytesin interfaceMetricOrBuilder- Returns:
- The bytes for name.
-
getDescription
description of the metric, which can be used in documentation.
string description = 2;- Specified by:
getDescriptionin interfaceMetricOrBuilder- 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:
getDescriptionBytesin interfaceMetricOrBuilder- Returns:
- The bytes for description.
-
getUnit
unit in which the metric value is reported. Follows the format described by https://unitsofmeasure.org/ucum.html.
string unit = 3;- Specified by:
getUnitin interfaceMetricOrBuilder- Returns:
- The unit.
-
getUnitBytes
public com.google.protobuf.ByteString getUnitBytes()unit in which the metric value is reported. Follows the format described by https://unitsofmeasure.org/ucum.html.
string unit = 3;- Specified by:
getUnitBytesin interfaceMetricOrBuilder- Returns:
- The bytes for unit.
-
hasGauge
public boolean hasGauge().opentelemetry.proto.metrics.v1.Gauge gauge = 5;- Specified by:
hasGaugein interfaceMetricOrBuilder- Returns:
- Whether the gauge field is set.
-
getGauge
.opentelemetry.proto.metrics.v1.Gauge gauge = 5;- Specified by:
getGaugein interfaceMetricOrBuilder- Returns:
- The gauge.
-
getGaugeOrBuilder
.opentelemetry.proto.metrics.v1.Gauge gauge = 5;- Specified by:
getGaugeOrBuilderin interfaceMetricOrBuilder
-
hasSum
public boolean hasSum().opentelemetry.proto.metrics.v1.Sum sum = 7;- Specified by:
hasSumin interfaceMetricOrBuilder- Returns:
- Whether the sum field is set.
-
getSum
.opentelemetry.proto.metrics.v1.Sum sum = 7;- Specified by:
getSumin interfaceMetricOrBuilder- Returns:
- The sum.
-
getSumOrBuilder
.opentelemetry.proto.metrics.v1.Sum sum = 7;- Specified by:
getSumOrBuilderin interfaceMetricOrBuilder
-
hasHistogram
public boolean hasHistogram().opentelemetry.proto.metrics.v1.Histogram histogram = 9;- Specified by:
hasHistogramin interfaceMetricOrBuilder- Returns:
- Whether the histogram field is set.
-
getHistogram
.opentelemetry.proto.metrics.v1.Histogram histogram = 9;- Specified by:
getHistogramin interfaceMetricOrBuilder- Returns:
- The histogram.
-
getHistogramOrBuilder
.opentelemetry.proto.metrics.v1.Histogram histogram = 9;- Specified by:
getHistogramOrBuilderin interfaceMetricOrBuilder
-
hasExponentialHistogram
public boolean hasExponentialHistogram().opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;- Specified by:
hasExponentialHistogramin interfaceMetricOrBuilder- Returns:
- Whether the exponentialHistogram field is set.
-
getExponentialHistogram
.opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;- Specified by:
getExponentialHistogramin interfaceMetricOrBuilder- Returns:
- The exponentialHistogram.
-
getExponentialHistogramOrBuilder
.opentelemetry.proto.metrics.v1.ExponentialHistogram exponential_histogram = 10;- Specified by:
getExponentialHistogramOrBuilderin interfaceMetricOrBuilder
-
hasSummary
public boolean hasSummary().opentelemetry.proto.metrics.v1.Summary summary = 11;- Specified by:
hasSummaryin interfaceMetricOrBuilder- Returns:
- Whether the summary field is set.
-
getSummary
.opentelemetry.proto.metrics.v1.Summary summary = 11;- Specified by:
getSummaryin interfaceMetricOrBuilder- Returns:
- The summary.
-
getSummaryOrBuilder
.opentelemetry.proto.metrics.v1.Summary summary = 11;- Specified by:
getSummaryOrBuilderin interfaceMetricOrBuilder
-
getMetadataList
Additional metadata attributes that describe the metric. [Optional]. Attributes are non-identifying. Consumers SHOULD NOT need to be aware of these attributes. These attributes MAY be used to encode information allowing for lossless roundtrip translation to / from another data model. 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 metadata = 12;- Specified by:
getMetadataListin interfaceMetricOrBuilder
-
getMetadataOrBuilderList
Additional metadata attributes that describe the metric. [Optional]. Attributes are non-identifying. Consumers SHOULD NOT need to be aware of these attributes. These attributes MAY be used to encode information allowing for lossless roundtrip translation to / from another data model. 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 metadata = 12;- Specified by:
getMetadataOrBuilderListin interfaceMetricOrBuilder
-
getMetadataCount
public int getMetadataCount()Additional metadata attributes that describe the metric. [Optional]. Attributes are non-identifying. Consumers SHOULD NOT need to be aware of these attributes. These attributes MAY be used to encode information allowing for lossless roundtrip translation to / from another data model. 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 metadata = 12;- Specified by:
getMetadataCountin interfaceMetricOrBuilder
-
getMetadata
Additional metadata attributes that describe the metric. [Optional]. Attributes are non-identifying. Consumers SHOULD NOT need to be aware of these attributes. These attributes MAY be used to encode information allowing for lossless roundtrip translation to / from another data model. 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 metadata = 12;- Specified by:
getMetadatain interfaceMetricOrBuilder
-
getMetadataOrBuilder
Additional metadata attributes that describe the metric. [Optional]. Attributes are non-identifying. Consumers SHOULD NOT need to be aware of these attributes. These attributes MAY be used to encode information allowing for lossless roundtrip translation to / from another data model. 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 metadata = 12;- Specified by:
getMetadataOrBuilderin interfaceMetricOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static Metric parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Metric parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Metric parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Metric.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-