% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Nginx module [metricbeat-module-nginx]

:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.

::::{dropdown} Learn more {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of {{beats}} and {{agent}}.

::::

:::::

This module periodically fetches metrics from Nginx servers.

The default metricset is stubstatus.

Compatibility [_compatibility_40]

The Nginx metricsets were tested with Nginx 1.23.2 and are expected to work with all version >= 1.9.

Dashboard [_dashboard_35]

The nginx module comes with a predefined dashboard. For example:

Example configuration [_example_configuration]

The Nginx module supports the standard configuration options that are described in Modules. Here is an example configuration:

yaml

metricbeat.modules:
- module: nginx
  metricsets: ["stubstatus"]
  enabled: true
  period: 10s

  # Nginx hosts
  hosts: ["http://127.0.0.1"]

  # Path to server status. Default nginx_status
  server_status_path: "nginx_status"

This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.

Metricsets [_metricsets]

The following metricsets are available:

stubstatus