jgaunt/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-12-10 05:13:45 +00:00
Code Issues Projects Releases Wiki Activity

rcserver: implement prometheus metrics on a dedicated port - fixes #7940

Browse Source
This commit is contained in:
Oleg Kunitsyn
2024-09-06 16:00:36 +02:00
committed by GitHub
parent 26bc9826e5
commit d15704ef9f
9 changed files with 226 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/content/docs.md
View File

@@ -2836,6 +2836,17 @@ Rclone prefixes all log messages with their level in capitals, e.g. INFO
which makes it easy to grep the log file for different kinds of
information.
Metrics
-------
Rclone can publish metrics in the OpenMetrics/Prometheus format.
To enable the metrics endpoint, use the `--metrics-addr` flag. Metrics can also be published on the `--rc-addr` port if the `--rc` flag and `--rc-enable-metrics` flags are supplied or if using rclone rcd `--rc-enable-metrics`
Rclone provides extensive configuration options for the metrics HTTP endpoint. These settings are grouped under the Metrics section and have a prefix `--metrics-*`.
When metrics are enabled with `--rc-enable-metrics`, they will be published on the same port as the rc API. In this case, the `--metrics-*` flags will be ignored, and the HTTP endpoint configuration will be managed by the `--rc-*` parameters.
Exit Code
---------

1
docs/content/rc.md
View File

@@ -100,6 +100,7 @@ Default Off.
### --rc-enable-metrics
Enable OpenMetrics/Prometheus compatible endpoint at `/metrics`.
If more control over the metrics is desired (for example running it on a different port or with different auth) then endpoint can be enabled with the `--metrics-*` flags instead.
Default Off.