---
title: "otelcol.receiver.nginx | Grafana Alloy documentation"
description: "Learn about otelcol.receiver.nginx"
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# `otelcol.receiver.nginx`

> **EXPERIMENTAL**: This is an [experimental](/docs/release-life-cycle/) component. Experimental components are subject to frequent breaking changes, and may be removed with no equivalent replacement. To enable and use an experimental component, you must set the `stability.level` [flag](/docs/alloy/next/reference/cli/run/) to `experimental`.

`otelcol.receiver.nginx` reads NGINX metrics and forwards them to other `otelcol.*` components.

> Note
> 
> `otelcol.receiver.nginx` is a wrapper over the upstream OpenTelemetry Collector [`nginx`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.147.0/receiver/nginxreceiver) receiver. Bug reports or feature requests will be redirected to the upstream repository, if necessary.

This receiver supports NGINX. Refer to the upstream [`nginx`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.147.0/receiver/nginxreceiver) receiver documentation for more details.

You can specify multiple `otelcol.receiver.nginx` components by giving them different labels.

## Usage

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
otelcol.receiver.nginx "<LABEL>" {
  endpoint = "http://localhost:80/status"

  collection_interval = "10s"
  initial_delay = "1s"

  output {
    metrics = [...]
  }
}
```

## Arguments

You can use the following arguments with `otelcol.receiver.nginx`:

Expand table

| Name                  | Type       | Description                                            | Default | Required |
|-----------------------|------------|--------------------------------------------------------|---------|----------|
| `endpoint`            | `string`   | The URL of the NGINX status endpoint.                  |         | yes      |
| `collection_interval` | `duration` | Defines how often to collect metrics.                  | `"10s"` | no       |
| `initial_delay`       | `duration` | Defines how long this receiver waits before it starts. | `"1s"`  | no       |

## Blocks

You can use the following blocks with `otelcol.receiver.nginx`:

No valid configuration blocks found.

### `output`

Required

The `output` block configures a set of components to forward resulting telemetry data to.

The following arguments are supported:

Expand table

| Name      | Type                     | Description                           | Default | Required |
|-----------|--------------------------|---------------------------------------|---------|----------|
| `logs`    | `list(otelcol.Consumer)` | List of consumers to send logs to.    | `[]`    | no       |
| `metrics` | `list(otelcol.Consumer)` | List of consumers to send metrics to. | `[]`    | no       |
| `traces`  | `list(otelcol.Consumer)` | List of consumers to send traces to.  | `[]`    | no       |

You must specify the `output` block, but all its arguments are optional. By default, telemetry data is dropped. Configure the `metrics`, `logs`, and `traces` arguments accordingly to send telemetry data to other components.

### `debug_metrics`

The `debug_metrics` block configures the metrics that this component generates to monitor its state.

The following arguments are supported:

Expand table

| Name                               | Type      | Description                                          | Default | Required |
|------------------------------------|-----------|------------------------------------------------------|---------|----------|
| `disable_high_cardinality_metrics` | `boolean` | Whether to disable certain high cardinality metrics. | `true`  | no       |

`disable_high_cardinality_metrics` is the Alloy equivalent to the `telemetry.disableHighCardinalityMetrics` feature gate in the OpenTelemetry Collector. It removes attributes that could cause high cardinality metrics. For example, attributes with IP addresses and port numbers in metrics about HTTP and gRPC connections are removed.

> Note
> 
> If configured, `disable_high_cardinality_metrics` only applies to `otelcol.exporter.*` and `otelcol.receiver.*` components.

## Exported fields

`otelcol.receiver.nginx` doesn’t export any fields.

## Component health

`otelcol.receiver.nginx` is only reported as unhealthy if given an invalid configuration.

## Debug information

`otelcol.receiver.nginx` doesn’t expose any component-specific debug information.

## Example

The following example collects all available metrics from an NGINX server and forwards them to an exporter.

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
otelcol.receiver.nginx "default" {
  endpoint = "http://localhost:80/status"

  output {
    metrics = [otelcol.exporter.otlp.default.input]
  }
}

otelcol.exporter.otlp "default" {
  client {
    endpoint = env("<OTLP_ENDPOINT>")
  }
}
```

## Compatible components

`otelcol.receiver.nginx` can accept arguments from the following components:

- Components that export [OpenTelemetry `otelcol.Consumer`](../../../compatibility/#opentelemetry-otelcolconsumer-exporters)

> Note
> 
> Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.