From df4d9ac536cbbd337e1f91d0a501912a5b0a998e Mon Sep 17 00:00:00 2001 From: justindeguzman Date: Mon, 18 Nov 2024 15:40:19 -0800 Subject: [PATCH] Add Prometheus docs to Keeper --- docs/en/guides/sre/keeper/index.md | 37 ++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/docs/en/guides/sre/keeper/index.md b/docs/en/guides/sre/keeper/index.md index 4427954821a..f669f2f136e 100644 --- a/docs/en/guides/sre/keeper/index.md +++ b/docs/en/guides/sre/keeper/index.md @@ -637,8 +637,41 @@ You can also use metrics from Prometheus endpoint to track the current size of b ## Prometheus -Keeper can expose metrics data for scraping from Prometheus. -Configuration is done in the [same way as for ClickHouse.](/docs/en/operations/server-configuration-parameters/settings#prometheus) +Keeper can expose metrics data for scraping from [Prometheus](https://prometheus.io). + +Settings: + +- `endpoint` – HTTP endpoint for scraping metrics by the Prometheus server. Start from ‘/’. +- `port` – Port for `endpoint`. +- `metrics` – Flag that sets to expose metrics from the [system.metrics](/docs/en/operations/system-tables/metrics) table. +- `events` – Flag that sets to expose metrics from the [system.events](/docs/en/operations/system-tables/events) table. +- `asynchronous_metrics` – Flag that sets to expose current metrics values from the [system.asynchronous_metrics](/docs/en/operations/system-tables/asynchronous_metrics) table. + +**Example** + +``` xml + + 0.0.0.0 + 8123 + 9000 + + + /metrics + 9363 + true + true + true + + + +``` + +Check (replace `127.0.0.1` with the IP addr or hostname of your ClickHouse server): +```bash +curl 127.0.0.1:9363/metrics +``` + +Please also see the ClickHouse Cloud [Prometheus integration](/docs/en/integrations/prometheus). ## ClickHouse Keeper User Guide