From c92140294949d8b8864f75c78b9e16c892c24b09 Mon Sep 17 00:00:00 2001 From: Cole Isaac <82131455+conceptualshark@users.noreply.github.com> Date: Tue, 10 Sep 2024 09:52:39 -0400 Subject: [PATCH] update additional metrics env var requirement --- .../zeebe-deployment/operations/metrics.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/docs/self-managed/zeebe-deployment/operations/metrics.md b/docs/self-managed/zeebe-deployment/operations/metrics.md index a81a4c1052..f0c9db8e0c 100644 --- a/docs/self-managed/zeebe-deployment/operations/metrics.md +++ b/docs/self-managed/zeebe-deployment/operations/metrics.md @@ -4,11 +4,7 @@ title: "Metrics" keywords: ["backpressure", "back-pressure", "back pressure"] --- -When operating a distributed system like Zeebe, it is important to put proper monitoring in place. - -To facilitate this, Zeebe exposes an extensive set of metrics. - -Zeebe exposes metrics over an embedded HTTP server. +When operating a distributed system like Zeebe, it is important to put proper monitoring in place. To facilitate this, Zeebe exposes an extensive set of metrics over an embedded HTTP server. ## Types of metrics @@ -17,8 +13,7 @@ Zeebe exposes metrics over an embedded HTTP server. ## Metrics format -Zeebe exposes metrics directly in Prometheus text format. -Read details of the format in the [Prometheus documentation][prom-format]. +Zeebe exposes metrics directly in the [Prometheus text format][prom-format]. **Example:** @@ -30,11 +25,11 @@ zeebe_stream_processor_records_total{action="processed",partition="1",} 20320.0 zeebe_stream_processor_records_total{action="skipped",partition="1",} 2153.0 ``` -## Configuring metrics +## Enable additional metrics -Configure the HTTP server to export the metrics in the [configuration file](../configuration/configuration.md). +Metrics are exported by default. To enable execution metrics, set the `ZEEBE_BROKER_EXECUTION_METRICS_EXPORTER_ENABLED` environment variable to `true` in your Zeebe [configuration file](../configuration/configuration.md). -## Connecting Prometheus +## Connect Prometheus As explained, Zeebe exposes the metrics over an HTTP server. The default port is `9600`.