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

backport metrics updates #4280

Merged
merged 3 commits into from
Sep 19, 2024
Merged

backport metrics updates #4280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
48bbcec
backport metrics updates
conceptualshark Sep 10, 2024
34c0123
remove changes from 8.2
conceptualshark Sep 10, 2024
78f6ef5
backport to 8.2
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
2 changes: 1 addition & 1 deletion 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 @@ -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`:

Expand Down
17 changes: 6 additions & 11 deletions versioned_docs/version-8.2/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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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 help with this, Zeebe exposes an extensive set of metrics over an embedded HTTP server.

Is facilitate too 'wordy'?


## 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,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`:

Expand Down
17 changes: 6 additions & 11 deletions versioned_docs/version-8.3/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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comment on 'facilitate', e.g. Hemingway readability/plain English


## 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,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`:

Expand Down
17 changes: 6 additions & 11 deletions versioned_docs/version-8.4/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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comments


## 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,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`:

Expand Down
17 changes: 6 additions & 11 deletions versioned_docs/version-8.5/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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See previous comments


## 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,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`:

Expand Down
Loading