Skip to content

Commit 31f3c36

Browse files
committed
Removed unneeded docs for observation tags. Already provided by micrometer doc generator
1 parent 4c5b88c commit 31f3c36

File tree

1 file changed

+3
-68
lines changed

1 file changed

+3
-68
lines changed

docs/src/main/asciidoc/features.adoc

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -394,77 +394,12 @@ To do so, add the process-aot execution and set `spring.cloud.task.single-step-i
394394
</executions>
395395
</plugin>
396396

397-
=== Enabling Micrometer Metrics and Observations for Spring Cloud Task
398-
399-
==== Timer
400-
The `spring.cloud.task` metric captures the information of a task following the execution of the task.
401-
Spring Cloud Task captures the following information for a Timer:
402-
403-
* spring.cloud.task - Task timer measurements. Records information about task duration and status.
404-
** application - Name assigned by `management.metrics.tags.application` property.
405-
** exit.code - The exit code of the application.
406-
** service - Service name assigned by the `management.metrics.tags.service` property.
407-
** execution.id - The execution id associated with the task execution.
408-
** parent.execution.id - The parent execution id associated with the task execution via the `spring.cloud.task.parent-execution-id` proeprty.
409-
** count - as recorded by the timer.
410-
** total_time - as recorded by the timer in seconds.
411-
** max - as recorded by the timer in seconds.
412-
* - LongTask timer measurement. Records the run-time status of long-time lasting tasks.
413-
414-
==== Long Task Timer
415-
The `spring.cloud.task.active` metric captures the information of a task during the task execution.
416-
Spring Cloud Task captures the following information for a Long Task Timer (active):
417-
418-
* spring.cloud.task - Task timer measurements. Records information about task duration and status.
419-
** application - Name assigned by `management.metrics.tags.application` property.
420-
** exit.code - The exit code of the application.
421-
** service - Service name assigned by the `management.metrics.tags.service` property.
422-
** execution.id - The execution id associated with the task execution.
423-
** parent.execution.id - The parent execution id associated with the task execution via the `spring.cloud.task.parent-execution-id` proeprty.
424-
** active_tasks - as recorded by the long task timer.
425-
** duration - as recorded by the long task timer.
426-
* spring.cloud.task.active - LongTask timer measurement. Records the run-time status of long-time lasting tasks.
427-
428-
429-
==== Observations
430-
Spring Cloud Task allows user to enable Observations for `CommandLineRunner` and `ApplicationRunner` s.
431-
432-
To Enable Task Observations for `ApplicationRunner` s or `CommandLineRunner` s set `spring.cloud.task.observation.enabled` to true.
397+
=== Enabling Observations for ApplicationRunner and CommandLineRunner
433398

434-
An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-metrics[here].
435399

436-
===== Runner Timer
437-
The `spring.cloud.task.runner` metric captures the information of a task application/commandline runner following the execution of the application/commandline runner.
438-
Spring Cloud Task captures the following information for a runner's Timer:
439-
440-
Spring Cloud Task establishes the following Observation with the following fields:
441-
442-
* spring.cloud.task.runner - Observed representation of a `CommandLineRunner` or `ApplicationRunner`.
443-
** application - Name assigned by `management.metrics.tags.application` property.
444-
** error - Exception that was thrown during `ApplicationRunner` or `CommandLineRunner` execution.
445-
** spring.cloud.task.runner.bean-name - The name of the bean for the `ApplicationRunner` or `CommandLineRunner`
446-
** execution.id - The execution id associated with the task execution.
447-
** parent.execution.id - The parent execution id associated with the task execution via the `spring.cloud.task.parent-execution-id` proeprty.
448-
** count - as recorded by the Observation.
449-
** total_time - as recorded by the Observation.
450-
** max - as recorded by the Observation.
451-
452-
===== Long Task Runner Timer
453-
The `spring.cloud.task.runner.active` metric captures the information of a task application/commandline runner during the execution of the application/commandline runner.
454-
Spring Cloud Task captures the following information for a runner's Long Task Timer:
455-
456-
Spring Cloud Task establishes the following Observation with the following fields:
457-
458-
* spring.cloud.task.runner - Observed representation of a `CommandLineRunner` or `ApplicationRunner`.
459-
** application - Name assigned by `management.metrics.tags.application` property.
460-
** error - Exception that was thrown during `ApplicationRunner` or `CommandLineRunner` execution.
461-
** spring.cloud.task.runner.bean-name - The name of the bean for the `ApplicationRunner` or `CommandLineRunner`
462-
** execution.id - The execution id associated with the task execution.
463-
** parent.execution.id - The parent execution id associated with the task execution via the `spring.cloud.task.parent-execution-id` proeprty.
464-
** count - as recorded by the Observation.
465-
** total_time - as recorded by the Observation.
466-
** max - as recorded by the Observation.
400+
To Enable Task Observations for `ApplicationRunner` or `CommandLineRunner` set `spring.cloud.task.observation.enabled` to true.
467401

402+
An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-metrics[here].
468403

469404
=== Disabling Spring Cloud Task Auto Configuration
470405

0 commit comments

Comments
 (0)