"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc" between
spring-boot-2.7.3.tar.gz and spring-boot-2.7.4.tar.gz

About: Spring Boot helps to create Spring-powered, production-grade applications and services.

metrics.adoc  (spring-boot-2.7.3):metrics.adoc  (spring-boot-2.7.4)
skipping to change at line 812 skipping to change at line 812
| `status` | `status`
| The response's HTTP status code if available (for example, `200` or `500`) or `IO_ERROR` in case of I/O issues. Otherwise, it is `CLIENT_ERROR`. | The response's HTTP status code if available (for example, `200` or `500`) or `IO_ERROR` in case of I/O issues. Otherwise, it is `CLIENT_ERROR`.
| `uri` | `uri`
| The request's URI template prior to variable substitution, if possible (for ex ample, `/api/person/\{id}`) | The request's URI template prior to variable substitution, if possible (for ex ample, `/api/person/\{id}`)
|=== |===
To customize the tags, and depending on your choice of client, you can provide a `@Bean` that implements `RestTemplateExchangeTagsProvider` or `WebClientExchang eTagsProvider`. To customize the tags, and depending on your choice of client, you can provide a `@Bean` that implements `RestTemplateExchangeTagsProvider` or `WebClientExchang eTagsProvider`.
There are convenience static functions in `RestTemplateExchangeTags` and `WebCli entExchangeTags`. There are convenience static functions in `RestTemplateExchangeTags` and `WebCli entExchangeTags`.
If you do not want to record metrics for all `RestTemplate` and `WebClient` requ
ests, set configprop:management.metrics.web.client.request.autotime.enabled[] to
`false`.
[[actuator.metrics.supported.tomcat]] [[actuator.metrics.supported.tomcat]]
==== Tomcat Metrics ==== Tomcat Metrics
Auto-configuration enables the instrumentation of Tomcat only when an `MBeanRegi stry` is enabled. Auto-configuration enables the instrumentation of Tomcat only when an `MBeanRegi stry` is enabled.
By default, the `MBeanRegistry` is disabled, but you can enable it by setting co nfigprop:server.tomcat.mbeanregistry.enabled[] to `true`. By default, the `MBeanRegistry` is disabled, but you can enable it by setting co nfigprop:server.tomcat.mbeanregistry.enabled[] to `true`.
Tomcat metrics are published under the `tomcat.` meter name. Tomcat metrics are published under the `tomcat.` meter name.
[[actuator.metrics.supported.cache]] [[actuator.metrics.supported.cache]]
==== Cache Metrics ==== Cache Metrics
Auto-configuration enables the instrumentation of all available `Cache` instance s on startup, with metrics prefixed with `cache`. Auto-configuration enables the instrumentation of all available `Cache` instance s on startup, with metrics prefixed with `cache`.
skipping to change at line 1119 skipping to change at line 1121
stack: "prod" stack: "prod"
---- ----
The preceding example adds `region` and `stack` tags to all meters with a value of `us-east-1` and `prod`, respectively. The preceding example adds `region` and `stack` tags to all meters with a value of `us-east-1` and `prod`, respectively.
NOTE: The order of common tags is important if you use Graphite. NOTE: The order of common tags is important if you use Graphite.
As the order of common tags cannot be guaranteed by using this approach, Graphit e users are advised to define a custom `MeterFilter` instead. As the order of common tags cannot be guaranteed by using this approach, Graphit e users are advised to define a custom `MeterFilter` instead.
[[actuator.metrics.customizing.per-meter-properties]] [[actuator.metrics.customizing.per-meter-properties]]
==== Per-meter Properties ==== Per-meter Properties
In addition to `MeterFilter` beans, you can apply a limited set of customization In addition to `MeterFilter` beans, you can apply a limited set of customization
on a per-meter basis by using properties. on a per-meter basis using properties.
Per-meter customizations apply to any meter IDs that start with the given name. Per-meter customizations are applied, using Spring Boot's `PropertiesMeterFilter
The following example disables any meters that have an ID starting with `example `, to any meter IDs that start with the given name.
.remote` The following example filters out any meters that have an ID starting with `exam
ple.remote`.
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]
---- ----
management: management:
metrics: metrics:
enable: enable:
example: example:
remote: false remote: false
---- ----
The following properties allow per-meter customization: The following properties allow per-meter customization:
.Per-meter customizations .Per-meter customizations
|=== |===
| Property | Description | Property | Description
| configprop:management.metrics.enable[] | configprop:management.metrics.enable[]
| Whether to prevent meters from emitting any metrics. | Whether to accept meters with certain IDs.
Meters that are not accepted are filtered from the `MeterRegistry`.
| configprop:management.metrics.distribution.percentiles-histogram[] | configprop:management.metrics.distribution.percentiles-histogram[]
| Whether to publish a histogram suitable for computing aggregable (across dimen sion) percentile approximations. | Whether to publish a histogram suitable for computing aggregable (across dimen sion) percentile approximations.
| configprop:management.metrics.distribution.minimum-expected-value[], configpro p:management.metrics.distribution.maximum-expected-value[] | configprop:management.metrics.distribution.minimum-expected-value[], configpro p:management.metrics.distribution.maximum-expected-value[]
| Publish fewer histogram buckets by clamping the range of expected values. | Publish fewer histogram buckets by clamping the range of expected values.
| configprop:management.metrics.distribution.percentiles[] | configprop:management.metrics.distribution.percentiles[]
| Publish percentile values computed in your application | Publish percentile values computed in your application
 End of changes. 3 change blocks. 
6 lines changed or deleted 12 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)