IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« MySQL status metricset Nginx stubstatus metricset »
Elastic Docs ›Metricbeat Reference [6.3] ›Modules

Nginx module

edit

Nginx module

edit

This module periodically fetches metrics from Nginx servers.

The default metricset is stubstatus.

Compatibility

edit

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

Dashboard

edit

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

metricbeat nginx

Example configuration

edit

The Nginx module supports the standard configuration options that are described in Specify which modules to run. 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 server-status
  server_status_path: "server-status"

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

Metricsets

edit

The following metricsets are available:

« MySQL status metricset Nginx stubstatus metricset »