Package io.opentelemetry.proto.metrics.v1

Enum AggregationTemporality

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<AggregationTemporality>
    public enum AggregationTemporality
extends Enum<AggregationTemporality>
implements com.google.protobuf.ProtocolMessageEnum
     AggregationTemporality defines how a metric aggregator reports aggregated
 values. It describes how those values relate to the time interval over
 which they are aggregated.
    Protobuf enum opentelemetry.proto.metrics.v1.AggregationTemporality

    • Enum Constant Detail

      • AGGREGATION_TEMPORALITY_UNSPECIFIED

        public static final AggregationTemporality AGGREGATION_TEMPORALITY_UNSPECIFIED
         UNSPECIFIED is the default AggregationTemporality, it MUST not be used.
        AGGREGATION_TEMPORALITY_UNSPECIFIED = 0;

      • AGGREGATION_TEMPORALITY_DELTA

        public static final AggregationTemporality AGGREGATION_TEMPORALITY_DELTA
         DELTA is an AggregationTemporality for a metric aggregator which reports
 changes since last report time. Successive metrics contain aggregation of
 values from continuous and non-overlapping intervals.
 The values for a DELTA metric are based only on the time interval
 associated with one measurement cycle. There is no dependency on
 previous measurements like is the case for CUMULATIVE metrics.
 For example, consider a system measuring the number of requests that
 it receives and reports the sum of these requests every second as a
 DELTA metric:
   1. The system starts receiving at time=t_0.
   2. A request is received, the system measures 1 request.
   3. A request is received, the system measures 1 request.
   4. A request is received, the system measures 1 request.
   5. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+1 with a value of 3.
   6. A request is received, the system measures 1 request.
   7. A request is received, the system measures 1 request.
   8. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0+1 to
      t_0+2 with a value of 2.
        AGGREGATION_TEMPORALITY_DELTA = 1;

      • AGGREGATION_TEMPORALITY_CUMULATIVE

        public static final AggregationTemporality AGGREGATION_TEMPORALITY_CUMULATIVE
         CUMULATIVE is an AggregationTemporality for a metric aggregator which
 reports changes since a fixed start time. This means that current values
 of a CUMULATIVE metric depend on all previous measurements since the
 start time. Because of this, the sender is required to retain this state
 in some form. If this state is lost or invalidated, the CUMULATIVE metric
 values MUST be reset and a new fixed start time following the last
 reported measurement time sent MUST be used.
 For example, consider a system measuring the number of requests that
 it receives and reports the sum of these requests every second as a
 CUMULATIVE metric:
   1. The system starts receiving at time=t_0.
   2. A request is received, the system measures 1 request.
   3. A request is received, the system measures 1 request.
   4. A request is received, the system measures 1 request.
   5. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+1 with a value of 3.
   6. A request is received, the system measures 1 request.
   7. A request is received, the system measures 1 request.
   8. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+2 with a value of 5.
   9. The system experiences a fault and loses state.
   10. The system recovers and resumes receiving at time=t_1.
   11. A request is received, the system measures 1 request.
   12. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_1 to
      t_0+1 with a value of 1.
 Note: Even though, when reporting changes since last report time, using
 CUMULATIVE is valid, it is not recommended. This may cause problems for
 systems that do not use start_time to determine when the aggregation
 value was reset (e.g. Prometheus).
        AGGREGATION_TEMPORALITY_CUMULATIVE = 2;

    • Field Detail

      • AGGREGATION_TEMPORALITY_UNSPECIFIED_VALUE

        public static final int AGGREGATION_TEMPORALITY_UNSPECIFIED_VALUE
         UNSPECIFIED is the default AggregationTemporality, it MUST not be used.
        AGGREGATION_TEMPORALITY_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • AGGREGATION_TEMPORALITY_DELTA_VALUE

        public static final int AGGREGATION_TEMPORALITY_DELTA_VALUE
         DELTA is an AggregationTemporality for a metric aggregator which reports
 changes since last report time. Successive metrics contain aggregation of
 values from continuous and non-overlapping intervals.
 The values for a DELTA metric are based only on the time interval
 associated with one measurement cycle. There is no dependency on
 previous measurements like is the case for CUMULATIVE metrics.
 For example, consider a system measuring the number of requests that
 it receives and reports the sum of these requests every second as a
 DELTA metric:
   1. The system starts receiving at time=t_0.
   2. A request is received, the system measures 1 request.
   3. A request is received, the system measures 1 request.
   4. A request is received, the system measures 1 request.
   5. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+1 with a value of 3.
   6. A request is received, the system measures 1 request.
   7. A request is received, the system measures 1 request.
   8. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0+1 to
      t_0+2 with a value of 2.
        AGGREGATION_TEMPORALITY_DELTA = 1;
        See Also:
        Constant Field Values

      • AGGREGATION_TEMPORALITY_CUMULATIVE_VALUE

        public static final int AGGREGATION_TEMPORALITY_CUMULATIVE_VALUE
         CUMULATIVE is an AggregationTemporality for a metric aggregator which
 reports changes since a fixed start time. This means that current values
 of a CUMULATIVE metric depend on all previous measurements since the
 start time. Because of this, the sender is required to retain this state
 in some form. If this state is lost or invalidated, the CUMULATIVE metric
 values MUST be reset and a new fixed start time following the last
 reported measurement time sent MUST be used.
 For example, consider a system measuring the number of requests that
 it receives and reports the sum of these requests every second as a
 CUMULATIVE metric:
   1. The system starts receiving at time=t_0.
   2. A request is received, the system measures 1 request.
   3. A request is received, the system measures 1 request.
   4. A request is received, the system measures 1 request.
   5. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+1 with a value of 3.
   6. A request is received, the system measures 1 request.
   7. A request is received, the system measures 1 request.
   8. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_0 to
      t_0+2 with a value of 5.
   9. The system experiences a fault and loses state.
   10. The system recovers and resumes receiving at time=t_1.
   11. A request is received, the system measures 1 request.
   12. The 1 second collection cycle ends. A metric is exported for the
      number of requests received over the interval of time t_1 to
      t_0+1 with a value of 1.
 Note: Even though, when reporting changes since last report time, using
 CUMULATIVE is valid, it is not recommended. This may cause problems for
 systems that do not use start_time to determine when the aggregation
 value was reset (e.g. Prometheus).
        AGGREGATION_TEMPORALITY_CUMULATIVE = 2;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static AggregationTemporality[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AggregationTemporality c : AggregationTemporality.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AggregationTemporality valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static AggregationTemporality valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static AggregationTemporality forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<AggregationTemporality> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static AggregationTemporality valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null