From ccb168de2181d1b9499725b430c2abb983221048 Mon Sep 17 00:00:00 2001 From: rolandtyler <88206508+rolandtyler@users.noreply.github.com> Date: Mon, 7 Mar 2022 13:55:54 -0500 Subject: [PATCH] Document metrics publish CLI options (#347) --- docs/Reference/CLI/CLI-Syntax.md | 57 ++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/docs/Reference/CLI/CLI-Syntax.md b/docs/Reference/CLI/CLI-Syntax.md index e52465155..066af3a1f 100644 --- a/docs/Reference/CLI/CLI-Syntax.md +++ b/docs/Reference/CLI/CLI-Syntax.md @@ -796,6 +796,63 @@ Host on which Prometheus accesses Teku metrics. The default is `127.0.0.1`. Specifies the port (TCP) on which [Prometheus](https://prometheus.io/) accesses Teku metrics. The default is `8008`. +### metrics-publish-endpoint + +=== "Syntax" + + ```bash + --metrics-publish-endpoint= + ``` + +=== "Example" + + ```bash + --metrics-publish-endpoint=https://beaconcha.in/api/v1/client/metrics?apikey={apikey} + ``` + +=== "Environment variable" + + ```bash + TEKU_METRICS_PUBLISH_ENDPOINT=https://beaconcha.in/api/v1/client/metrics?apikey={apikey} + ``` + +=== "Configuration file" + + ```bash + metrics-publish-endpoint: "https://beaconcha.in/api/v1/client/metrics?apikey={apikey}" + ``` + +Endpoint URL of an external service such as [beaconcha.in](https://beaconcha.in/) to which Teku publishes metrics for node monitoring. + +### metrics-publish-interval + +=== "Syntax" + + ```bash + --metrics-publish-interval= + ``` + +=== "Example" + + ```bash + --metrics-publish-interval=60 + ``` + +=== "Environment variable" + + ```bash + TEKU_METRICS_PUBLISH_INTERVAL=60 + ``` + +=== "Configuration file" + + ```bash + metrics-publish-interval: "60" + ``` + +Interval between metric publications to the external service defined in [metrics-publish-endpoint](#metrics-publish-endpoint), measured in seconds. +The default is `60`. + ### network === "Syntax"