# prometheus

> For the complete documentation index, see [llms.txt](https://docs.redpanda.com/llms.txt). Component-specific: [connect-full.txt](https://docs.redpanda.com/connect-full.txt)

---
title: prometheus
latest-connect-version: 4.93.0
latest-operator-version: v26.1.4
latest-console-tag: v3.7.3
latest-redpanda-tag: v26.1.9
docname: metrics/prometheus
page-component-name: connect
page-version: master
page-component-version: master
page-component-title: Connect
page-relative-src-path: metrics/prometheus.adoc
page-edit-url: https://github.com/redpanda-data/rp-connect-docs/edit/main/modules/components/pages/metrics/prometheus.adoc
page-git-created-date: "2024-05-24"
page-git-modified-date: "2026-05-26"
---

<!-- Source: https://docs.redpanda.com/connect/components/metrics/prometheus.md -->

**Available in:** [Cloud](https://docs.redpanda.com/cloud-data-platform/develop/connect/components/metrics/prometheus/%20%22View%20the%20Cloud%20version%20of%20this%20component%22), Self-Managed

Host endpoints (`/metrics` and `/stats`) for Prometheus scraping.

#### Common

```yml
metrics:
  prometheus:
```

#### Advanced

```yml
metrics:
  prometheus:
    use_histogram_timing: false
    histogram_buckets: []
    summary_quantiles_objectives:
      - error: 0.05
        quantile: 0.5
      - error: 0.01
        quantile: 0.9
      - error: 0.001
        quantile: 0.99
    add_process_metrics: false
    add_go_metrics: false
    push_url: "" # No default (optional)
    push_interval: "" # No default (optional)
    push_job_name: benthos_push
    push_basic_auth:
      username: ""
      password: ""
    file_output_path: ""
```

## [](#fields)Fields

### [](#add_go_metrics)`add_go_metrics`

Whether to export Go runtime metrics such as GC pauses in addition to Redpanda Connect metrics.

**Type**: `bool`

**Default**: `false`

### [](#add_process_metrics)`add_process_metrics`

Whether to export process metrics such as CPU and memory usage in addition to Redpanda Connect metrics.

**Type**: `bool`

**Default**: `false`

### [](#file_output_path)`file_output_path`

An optional file path to write all prometheus metrics on service shutdown.

**Type**: `string`

**Default**: `""`

### [](#histogram_buckets)`histogram_buckets[]`

Timing metrics histogram buckets (in seconds). If left empty defaults to DefBuckets ([https://pkg.go.dev/github.com/prometheus/client\_golang/prometheus#pkg-variables](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#pkg-variables)). Applicable when `use_histogram_timing` is set to `true`.

Requires version 3.63.0 or later.

**Type**: `float`

**Default**: `[]`

### [](#push_basic_auth)`push_basic_auth`

The Basic Authentication credentials.

**Type**: `object`

### [](#push_basic_auth-password)`push_basic_auth.password`

The Basic Authentication password.

> ⚠️ **CAUTION**
>
> This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see [Secrets](https://docs.redpanda.com/connect/configuration/secrets/).

**Type**: `string`

**Default**: `""`

### [](#push_basic_auth-username)`push_basic_auth.username`

The Basic Authentication username.

**Type**: `string`

**Default**: `""`

### [](#push_interval)`push_interval`

The period of time between each push when sending metrics to a Push Gateway.

**Type**: `string`

### [](#push_job_name)`push_job_name`

An identifier for push jobs.

**Type**: `string`

**Default**: `benthos_push`

### [](#push_url)`push_url`

An optional [Push Gateway URL](#push-gateway) to push metrics to.

**Type**: `string`

### [](#summary_quantiles_objectives)`summary_quantiles_objectives[]`

A list of timing metrics summary buckets (as quantiles). Applicable when `use_histogram_timing` is set to `false`.

Requires version 4.23.0 or later.

**Type**: `object`

**Default**:

```yaml
- error: 0.05
  quantile: 0.5
- error: 0.01
  quantile: 0.9
- error: 0.001
  quantile: 0.99
```

```yaml
# Examples:
summary_quantiles_objectives:
  - error: 0.05
    quantile: 0.5
  - error: 0.01
    quantile: 0.9
  - error: 0.001
    quantile: 0.99
```

### [](#summary_quantiles_objectives-error)`summary_quantiles_objectives[].error`

Permissible margin of error for quantile calculations. Precise calculations in a streaming context (without prior knowledge of the full dataset) can be resource-intensive. To balance accuracy with computational efficiency, an error margin is introduced. For instance, if the 90th quantile (`0.9`) is determined to be `100ms` with a 1% error margin (`0.01`), the true value will fall within the `[99ms, 101ms]` range.)

**Type**: `float`

**Default**: `0`

### [](#summary_quantiles_objectives-quantile)`summary_quantiles_objectives[].quantile`

Quantile value.

**Type**: `float`

**Default**: `0`

### [](#use_histogram_timing)`use_histogram_timing`

Whether to export timing metrics as a histogram, if `false` a summary is used instead. When exporting histogram timings the delta values are converted from nanoseconds into seconds in order to better fit within bucket definitions. For more information on histograms and summaries refer to: [https://prometheus.io/docs/practices/histograms/](https://prometheus.io/docs/practices/histograms/).

Requires version 3.63.0 or later.

**Type**: `bool`

**Default**: `false`

## [](#push-gateway)Push gateway

The field `push_url` is optional and when set will trigger a push of metrics to a [Prometheus Push Gateway](https://prometheus.io/docs/instrumenting/pushing/) once Redpanda Connect shuts down. It is also possible to specify a `push_interval` which results in periodic pushes.

The Push Gateway is useful for when Redpanda Connect instances are short lived. Do not include the "/metrics/jobs/…​" path in the push URL.

If the Push Gateway requires HTTP Basic Authentication it can be configured with `push_basic_auth`.