# Nginx

### Supported Platforms

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    | ✓       | ✓    | ✓      |
| Windows  | ✓       | ✓    | ✓      |
| macOS    | ✓       | ✓    | ✓      |

### Prerequisites

This source supports nginx versions 1.18 and 1.20.

### Configuration Table

| Parameter                   | Type                | Default                          | Description                                                                                    |
| --------------------------- | ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------- |
| telemetry\_types            | `telemetrySelector` | `["Logs", "Metrics"]`            | Choose Telemetry Type.                                                                         |
| data\_flow                  | `enum`              | high                             | Enable high flow or reduced low flow.                                                          |
| log\_format                 | `enum`              | default                          |                                                                                                |
| access\_log\_paths          | `strings`           | `- "/var/log/nginx/access.log*"` | Path to NGINX access log file(s).                                                              |
| error\_log\_paths           | `strings`           | `- "/var/log/nginx/error.log*"`  | Path to NGINX error log file(s).                                                               |
| start\_at                   | `enum`              | end                              | Start reading the file from the 'beginning' or 'end'.                                          |
| endpoint\*                  | `string`            | "<http://localhost:80/status>"   | The endpoint of the NGINX server.                                                              |
| collection\_interval        | `int`               | 60                               | Sets how often (seconds) to scrape for metrics.                                                |
| otlp\_grpc\_port            | `int`               | 4317                             | TCP port to receive OTLP trace data using the gRPC protocol.                                   |
| otlp\_grpc\_listen\_address | `string`            | "0.0.0.0"                        | The IP address to listen on for OTLP gRPC trace data from the NGINX otel module.               |
| enable\_tls                 | `bool`              | false                            | Whether or not to use TLS.                                                                     |
| insecure\_skip\_verify      | `bool`              | false                            | Enable to skip TLS certificate verification.                                                   |
| ca\_file                    | `string`            |                                  | Certificate authority used to validate the database server's TLS certificate.                  |
| cert\_file                  | `string`            |                                  | A TLS certificate used for client authentication if mutual TLS is enabled.                     |
| key\_file                   | `string`            |                                  | A TLS private key used for client authentication if mutual TLS is enabled.                     |
| mutual\_tls                 | `bool`              | false                            | Whether or not to require client TLS authentication (mTLS). Only relevant when TLS is enabled. |

<mark style="color:red;">\*</mark>*<mark style="color:red;">required field</mark>*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/nginx.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.