Loading

Nginx module

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

This module periodically fetches metrics from Nginx servers.

The default metricset is stubstatus.

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

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

metricbeat nginx

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

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.

The following metricsets are available: