root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Update 'HTTP Client Metrics' reference documentation 

Since gh-#5594, the 'outcome' tag has been introduced for
HTTP clients. This commit updates the reference documentation
accordingly.

Closes gh-15725
This commit is contained in:
Michael McFadyen 2019-01-17 12:14:42 -05:00 committed by Brian Clozel
parent cea6a79e49
commit 9eeeebcd53
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@ -1963,11 +1963,28 @@ customized by setting the `management.metrics.web.client.requests-metric-name` p
By default, metrics generated by an instrumented client are tagged with the
following information:
* `method`, the request's method (for example, `GET` or `POST`).
* `uri`, the request's URI template prior to variable substitution, if possible (for
example, `/api/person/{id}`).
* `status`, the response's HTTP status code (for example, `200` or `500`).
* `clientName`, the host portion of the URI.
|===
|Tag |Description
|`clientName`
|Host portion of the URI
|`method`
|Request's method (for example, `GET` or `POST`)
|`outcome`
|Request's outcome based on the status code of the response. 1xx is
`INFORMATIONAL`, 2xx is `SUCCESS`, 3xx is `REDIRECTION`, 4xx `CLIENT_ERROR`, and 5xx is
`SERVER_ERROR`
|`status`
|Response's HTTP status code (for example, `200` or `500`)
|`uri`
|Request's URI template prior to variable substitution, if possible (for example,
`/api/person/{id}`)
|===
To customize the tags, and depending on your choice of client, you can provide
a `@Bean` that implements `RestTemplateExchangeTagsProvider` or