From 48bbcec50027bb1b76c49f93055170277b8a41ee Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Tue, 10 Sep 2024 10:14:26 -0400 Subject: [PATCH 1/3] backport metrics updates --- .../zeebe-deployment/operations/metrics.md | 2 +- .../zeebe-deployment/operations/metrics.md | 17 ++++++----------- .../zeebe-deployment/operations/metrics.md | 17 ++++++----------- .../zeebe-deployment/operations/metrics.md | 17 ++++++----------- .../zeebe-deployment/operations/metrics.md | 17 ++++++----------- 5 files changed, 25 insertions(+), 45 deletions(-) diff --git a/docs/self-managed/zeebe-deployment/operations/metrics.md b/docs/self-managed/zeebe-deployment/operations/metrics.md index f0c9db8e0c..52cabef81b 100644 --- a/docs/self-managed/zeebe-deployment/operations/metrics.md +++ b/docs/self-managed/zeebe-deployment/operations/metrics.md @@ -31,7 +31,7 @@ Metrics are exported by default. To enable execution metrics, set the `ZEEBE_BRO ## Connect Prometheus -As explained, Zeebe exposes the metrics over an HTTP server. The default port is `9600`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md index d2db94311a..5c322a883e 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.2/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,13 +25,13 @@ 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`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/metrics.md index 700cfd4d50..1c2ff76b1f 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.3/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,13 +25,13 @@ 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`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: diff --git a/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/metrics.md index 241cf16184..ba4cf3b9f9 100644 --- a/versioned_docs/version-8.4/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.4/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,13 +25,13 @@ 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`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/metrics.md index 2fb85021ed..a6369647eb 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.5/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,13 +25,13 @@ 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`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: From 34c0123731ab314085369045436c0e40f2221ed0 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Tue, 10 Sep 2024 10:25:50 -0400 Subject: [PATCH 2/3] remove changes from 8.2 --- .../zeebe-deployment/operations/metrics.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md index 5c322a883e..d2db94311a 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md @@ -4,7 +4,11 @@ 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 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. + +Zeebe exposes metrics over an embedded HTTP server. ## Types of metrics @@ -13,7 +17,8 @@ When operating a distributed system like Zeebe, it is important to put proper mo ## Metrics format -Zeebe exposes metrics directly in the [Prometheus text format][prom-format]. +Zeebe exposes metrics directly in Prometheus text format. +Read details of the format in the [Prometheus documentation][prom-format]. **Example:** @@ -25,13 +30,13 @@ zeebe_stream_processor_records_total{action="processed",partition="1",} 20320.0 zeebe_stream_processor_records_total{action="skipped",partition="1",} 2153.0 ``` -## Enable additional metrics +## Configuring metrics -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). +Configure the HTTP server to export the metrics in the [configuration file](../configuration/configuration.md). -## Connect Prometheus +## Connecting Prometheus -Zeebe exposes the metrics over an HTTP server. The default port is `9600`. +As explained, Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: From 78f6ef5a1fa45db85e8f7b10e7f9cb741d06f237 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Tue, 10 Sep 2024 10:44:50 -0400 Subject: [PATCH 3/3] backport to 8.2 --- .../zeebe-deployment/operations/metrics.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md index d2db94311a..5c322a883e 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/operations/metrics.md +++ b/versioned_docs/version-8.2/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,13 +25,13 @@ 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`. +Zeebe exposes the metrics over an HTTP server. The default port is `9600`. Add the following entry to your `prometheus.yml`: