Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add micrometer metrics tags in reference documentation

Browse Source 
Resolves #3751
This commit is contained in:
Mahmoud Ben Hassine
2020-09-22 11:03:27 +02:00
parent c2625b1f87
commit 90610d5036
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-batch-docs/asciidoc/monitoring-and-metrics.adoc
View File

@@ -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