A newer version is available. For the latest information, see the current release documentation.
« NATS subscriptions metricset Nginx stubstatus metricset »
Elastic Docs ›Metricbeat Reference [7.17] ›Modules

Nginx module

edit

Nginx module

edit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified agent that you can deploy to hosts or containers to collect data and send it to the Elastic Stack. Elastic Agent uses integrations to connect your data to the Elastic Stack. Behind the scenes, Elastic Agent runs the Beats shippers required for your configuration. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

This module periodically fetches metrics from Nginx servers.

The default metricset is stubstatus.

Compatibility

edit

The Nginx metricsets were tested with Nginx 1.23.2 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 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.

Metricsets

edit

The following metricsets are available:

« NATS subscriptions metricset Nginx stubstatus metricset »