AGGREGATION_TEMPORALITY_CUMULATIVE

io.opentelemetry.proto.metrics.v1.metrics.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).

Attributes

Source
AggregationTemporality.scala
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Recognized
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
Source
Mirror.scala

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
Source
Mirror.scala
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton
Source
Mirror.scala

Value members

Concrete methods

Inherited methods

Attributes

Inherited from:
AggregationTemporality
Source
AggregationTemporality.scala
def companion: GeneratedEnumCompanion[AggregationTemporality]

Attributes

Inherited from:
AggregationTemporality
Source
AggregationTemporality.scala
def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
Source
Mirror.scala

Attributes

Inherited from:
GeneratedEnum
Source
GeneratedMessageCompanion.scala
def javaValueDescriptor: EnumValueDescriptor

Attributes

Inherited from:
GeneratedEnum
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
def scalaValueDescriptor: EnumValueDescriptor

Attributes

Inherited from:
GeneratedEnum
Source
GeneratedMessageCompanion.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
GeneratedEnum -> Any
Inherited from:
GeneratedEnum
Source
GeneratedMessageCompanion.scala

Concrete fields

val index: Int

Attributes

Source
AggregationTemporality.scala
val name: String

Attributes

Source
AggregationTemporality.scala

Inherited fields

val value: Int

Attributes

Inherited from:
AggregationTemporality
Source
AggregationTemporality.scala