Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add metrics env var requirement #4262

Merged
merged 3 commits into from
Sep 10, 2024
Merged

add metrics env var requirement #4262

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f032812
add metrics env var requirement
conceptualshark Sep 5, 2024
79fa2f9
metrics page cleanup
conceptualshark Sep 5, 2024
9d9f70b
specify additional execution metrics
conceptualshark Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions docs/self-managed/zeebe-deployment/operations/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:**

Expand All @@ -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`.

Expand Down
Loading