docs: Update info about metrics for 2.6

Also add events.handlers namespace and fix dhall link.
This commit is contained in:
Matthew Holt 2022-09-20 13:27:27 -06:00
parent 7ed2cf1bfa
commit 685dfc83c1
No known key found for this signature in database
GPG key ID: 2A349DD577D586A5
5 changed files with 25 additions and 2 deletions

View file

@ -5,7 +5,7 @@ title: metrics (Caddyfile directive)
# metrics
Configures a Prometheus metrics exposition endpoint so the gathered metrics can
be exposed for scraping.
be exposed for scraping. **Metrics must be [turned on in your global options](/docs/caddyfile/options#metrics) first.**
Note that a `/metrics` endpoint is also attached to the [admin API](/docs/api),
which is not configurable, and is not available when the admin API is disabled.

View file

@ -105,6 +105,7 @@ Possible options are:
write <duration>
idle <duration>
}
metrics
max_header_size <size>
log_credentials
protocols [h1|h2|h2c|h3]
@ -381,6 +382,11 @@ listener_wrappers {
- **idle** is a [duration value](/docs/conventions#durations) that sets the maximum time to wait for the next request when keep-alives are enabled. Defaults to 5 minutes to help avoid resource exhaustion.
##### `metrics`
Enables Prometheus metrics collection; necessary before scraping metrics. Note that metrics reduce performance on really busy servers. (Our community is working on improving this. Please get involved!)
##### `max_header_size`
The maximum size to parse from a client's HTTP request headers. It accepts all formats supported by [go-humanize](https://github.com/dustin/go-humanize/blob/master/bytes.go).