This version is still in development and is not considered stable yet. For the latest stable version, please use spring-cloud-task 3.1.2!

Observability

Observability metadata

Observability - Metrics

Below you can find a list of all metrics declared by this project.

Task Active

Metrics created around a task execution.

Metric name spring.cloud.task (defined by convention class org.springframework.cloud.task.listener.DefaultTaskExecutionObservationConvention). Type timer.

Metric name spring.cloud.task.active (defined by convention class org.springframework.cloud.task.listener.DefaultTaskExecutionObservationConvention). Type long task timer.

KeyValues that are added after starting the Observation might be missing from the *.active metrics.
Micrometer internally uses nanoseconds for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds)

Fully qualified name of the enclosing class org.springframework.cloud.task.listener.TaskExecutionObservation.

All tags must be prefixed with spring.cloud.task prefix!
Table 1. Low cardinality Keys

Name

Description

spring.cloud.task.cf.app.id (required)

App id for CF cloud.

spring.cloud.task.cf.app.name (required)

App name for CF cloud.

spring.cloud.task.cf.app.version (required)

App version for CF cloud.

spring.cloud.task.cf.instance.index (required)

Instance index for CF cloud.

spring.cloud.task.cf.org.name (required)

Organization Name for CF cloud.

spring.cloud.task.cf.space.id (required)

Space id for CF cloud.

spring.cloud.task.cf.space.name (required)

Space name for CF cloud.

spring.cloud.task.execution.id (required)

Task execution id.

spring.cloud.task.exit.code (required)

Task exit code.

spring.cloud.task.external.execution.id (required)

External execution id for task.

spring.cloud.task.name (required)

Task name measurement.

spring.cloud.task.parent.execution.id (required)

Task parent execution id.

spring.cloud.task.status (required)

task status. Can be either success or failure.

Task Runner Observation

Observation created when a task runner is executed.

Metric name spring.cloud.task.runner (defined by convention class org.springframework.cloud.task.configuration.observation.DefaultTaskObservationConvention). Type timer.

Metric name spring.cloud.task.runner.active (defined by convention class org.springframework.cloud.task.configuration.observation.DefaultTaskObservationConvention). Type long task timer.

KeyValues that are added after starting the Observation might be missing from the *.active metrics.
Micrometer internally uses nanoseconds for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds)

Fully qualified name of the enclosing class org.springframework.cloud.task.configuration.observation.TaskDocumentedObservation.

All tags must be prefixed with spring.cloud.task prefix!
Table 2. Low cardinality Keys

Name

Description

spring.cloud.task.runner.bean-name (required)

Name of the bean that was executed by Spring Cloud Task.

Observability - Spans

Below you can find a list of all spans declared by this project.

Task Active Span

Metrics created around a task execution.

Span name spring.cloud.task (defined by convention class org.springframework.cloud.task.listener.DefaultTaskExecutionObservationConvention).

Fully qualified name of the enclosing class org.springframework.cloud.task.listener.TaskExecutionObservation.

All tags must be prefixed with spring.cloud.task prefix!
Table 3. Tag Keys

Name

Description

spring.cloud.task.cf.app.id (required)

App id for CF cloud.

spring.cloud.task.cf.app.name (required)

App name for CF cloud.

spring.cloud.task.cf.app.version (required)

App version for CF cloud.

spring.cloud.task.cf.instance.index (required)

Instance index for CF cloud.

spring.cloud.task.cf.org.name (required)

Organization Name for CF cloud.

spring.cloud.task.cf.space.id (required)

Space id for CF cloud.

spring.cloud.task.cf.space.name (required)

Space name for CF cloud.

spring.cloud.task.execution.id (required)

Task execution id.

spring.cloud.task.exit.code (required)

Task exit code.

spring.cloud.task.external.execution.id (required)

External execution id for task.

spring.cloud.task.name (required)

Task name measurement.

spring.cloud.task.parent.execution.id (required)

Task parent execution id.

spring.cloud.task.status (required)

task status. Can be either success or failure.

Task Runner Observation Span

Observation created when a task runner is executed.

Span name spring.cloud.task.runner (defined by convention class org.springframework.cloud.task.configuration.observation.DefaultTaskObservationConvention).

Fully qualified name of the enclosing class org.springframework.cloud.task.configuration.observation.TaskDocumentedObservation.

All tags must be prefixed with spring.cloud.task prefix!
Table 4. Tag Keys

Name

Description

spring.cloud.task.runner.bean-name (required)

Name of the bean that was executed by Spring Cloud Task.