Usage of the Monitor Micrometer Extension¶
After enabling the Monitor Micrometer extension in the monitor.properties
file by setting micrometer.enable
to true
,
HTTP requests made to GeoServer will be processed by the extension and recorded in Micrometer’s internal registry.
The collected metrics are exposed through geoserver/rest/monitor/requests/metrics, which provides an HTTP endpoint compatible with Prometheus’s scraper.
Note
The metrics page will initially be empty if no requests have been made to GeoServer. To verify whether requests have been recorded by the monitoring system, you can query the Monitor request data storage via HTTP, accessible at geoserver/rest/monitor/requests.html.
Metrics Collected¶
The following is a list of metrics collected by the Monitor Micrometer extension, formatted for compatibility with Prometheus as displayed on the metrics page. For further details, refer to the Monitoring Extension documentation.
requests_total_seconds
requests_total_seconds (summary): tracks the total duration of requests (
sum
) and their number (count
).requests_total_seconds_max (gauge): tracks the highest recorded request time at a given moment (
max
).
requests_response_length_bytes
requests_response_length_bytes (summary): tracks the length of responses (
sum
) and their number (count
).requests_response_length_bytes_max (gauge): tracks the highest recorded response length at a given moment (
max
).
requests_processing_seconds
requests_processing_seconds (summary): tracks the total duration of request processing (
sum
) and the number of requests (count
).requests_processing_seconds_max (gauge): tracks the highest recorded request processing time at a given moment (
max
).
requests_labelling_processing_seconds
requests_labelling_processing_seconds (summary): tracks the total duration of labeling processing (
sum
) and the number of requests (count
).requests_labelling_processing_seconds_max (gauge): tracks the highest recorded labelling processing time at a given moment (
max
).
requests_host_total
micrometer.metric.remote_host.enabled
is set to true.
requests_host_total (counter): tracks the total number of requests for each unique combination of remote address, remote host, and remote user (
total
).