From 90610d5036ae3be7db09375e0ab02366e334c9c9 Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Tue, 22 Sep 2020 11:03:27 +0200 Subject: [PATCH] Add micrometer metrics tags in reference documentation Resolves #3751 --- .../asciidoc/monitoring-and-metrics.adoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/spring-batch-docs/asciidoc/monitoring-and-metrics.adoc b/spring-batch-docs/asciidoc/monitoring-and-metrics.adoc index efb015ced..32014d7dc 100644 --- a/spring-batch-docs/asciidoc/monitoring-and-metrics.adoc +++ b/spring-batch-docs/asciidoc/monitoring-and-metrics.adoc @@ -20,15 +20,17 @@ link:$$https://micrometer.io/docs/concepts#_global_registry$$[Micrometer's globa under the `spring.batch` prefix. The following table explains all the metrics in details: |=============== -|__Metric Name__|__Type__|__Description__ -|`spring.batch.job`|`TIMER`|Duration of job execution -|`spring.batch.job.active`|`LONG_TASK_TIMER`|Currently active jobs -|`spring.batch.step`|`TIMER`|Duration of step execution -|`spring.batch.item.read`|`TIMER`|Duration of item reading -|`spring.batch.item.process`|`TIMER`|Duration of item processing -|`spring.batch.chunk.write`|`TIMER`|Duration of chunk writing +|__Metric Name__|__Type__|__Description__|__Tags__ +|`spring.batch.job`|`TIMER`|Duration of job execution|`name`, `status` +|`spring.batch.job.active`|`LONG_TASK_TIMER`|Currently active jobs|`name` +|`spring.batch.step`|`TIMER`|Duration of step execution|`name`, `job.name`, `status` +|`spring.batch.item.read`|`TIMER`|Duration of item reading|`job.name`, `step.name`, `status` +|`spring.batch.item.process`|`TIMER`|Duration of item processing|`job.name`, `step.name`, `status` +|`spring.batch.chunk.write`|`TIMER`|Duration of chunk writing|`job.name`, `step.name`, `status` |=============== +NOTE: The `status` tag can be either `SUCCESS` or `FAILURE`. + [[custom-metrics]] === Custom metrics