Observability

Observability metadata

Observability - Metrics

Below you can find a list of all metrics declared by this project.spring-doc.cn

Task Active

Metrics created around a task execution.spring-doc.cn

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

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

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.spring-doc.cn

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

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.task.cf.app.id (required)spring-doc.cn

App id for CF cloud.spring-doc.cn

spring.cloud.task.cf.app.name (required)spring-doc.cn

App name for CF cloud.spring-doc.cn

spring.cloud.task.cf.app.version (required)spring-doc.cn

App version for CF cloud.spring-doc.cn

spring.cloud.task.cf.instance.index (required)spring-doc.cn

Instance index for CF cloud.spring-doc.cn

spring.cloud.task.cf.org.name (required)spring-doc.cn

Organization Name for CF cloud.spring-doc.cn

spring.cloud.task.cf.space.id (required)spring-doc.cn

Space id for CF cloud.spring-doc.cn

spring.cloud.task.cf.space.name (required)spring-doc.cn

Space name for CF cloud.spring-doc.cn

spring.cloud.task.execution.id (required)spring-doc.cn

Task execution id.spring-doc.cn

spring.cloud.task.exit.code (required)spring-doc.cn

Task exit code.spring-doc.cn

spring.cloud.task.external.execution.id (required)spring-doc.cn

External execution id for task.spring-doc.cn

spring.cloud.task.name (required)spring-doc.cn

Task name measurement.spring-doc.cn

spring.cloud.task.parent.execution.id (required)spring-doc.cn

Task parent execution id.spring-doc.cn

spring.cloud.task.status (required)spring-doc.cn

task status. Can be either success or failure.spring-doc.cn

Task Runner Observation

Observation created when a task runner is executed.spring-doc.cn

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

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

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.spring-doc.cn

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

Namespring-doc.cn

Descriptionspring-doc.cn

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

Name of the bean that was executed by Spring Cloud Task.spring-doc.cn

Observability - Spans

Below you can find a list of all spans declared by this project.spring-doc.cn

Task Active Span

Metrics created around a task execution.spring-doc.cn

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

Fully qualified name of the enclosing class org.springframework.cloud.task.listener.TaskExecutionObservation.spring-doc.cn

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

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.task.cf.app.id (required)spring-doc.cn

App id for CF cloud.spring-doc.cn

spring.cloud.task.cf.app.name (required)spring-doc.cn

App name for CF cloud.spring-doc.cn

spring.cloud.task.cf.app.version (required)spring-doc.cn

App version for CF cloud.spring-doc.cn

spring.cloud.task.cf.instance.index (required)spring-doc.cn

Instance index for CF cloud.spring-doc.cn

spring.cloud.task.cf.org.name (required)spring-doc.cn

Organization Name for CF cloud.spring-doc.cn

spring.cloud.task.cf.space.id (required)spring-doc.cn

Space id for CF cloud.spring-doc.cn

spring.cloud.task.cf.space.name (required)spring-doc.cn

Space name for CF cloud.spring-doc.cn

spring.cloud.task.execution.id (required)spring-doc.cn

Task execution id.spring-doc.cn

spring.cloud.task.exit.code (required)spring-doc.cn

Task exit code.spring-doc.cn

spring.cloud.task.external.execution.id (required)spring-doc.cn

External execution id for task.spring-doc.cn

spring.cloud.task.name (required)spring-doc.cn

Task name measurement.spring-doc.cn

spring.cloud.task.parent.execution.id (required)spring-doc.cn

Task parent execution id.spring-doc.cn

spring.cloud.task.status (required)spring-doc.cn

task status. Can be either success or failure.spring-doc.cn

Task Runner Observation Span

Observation created when a task runner is executed.spring-doc.cn

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

Fully qualified name of the enclosing class org.springframework.cloud.task.configuration.observation.TaskDocumentedObservation.spring-doc.cn

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

Namespring-doc.cn

Descriptionspring-doc.cn

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

Name of the bean that was executed by Spring Cloud Task.spring-doc.cn