59 lines
1.2 KiB
Text
59 lines
1.2 KiB
Text
////
|
|
This file is generated! See scripts/docs_collector.py
|
|
////
|
|
|
|
[[metricbeat-module-nginx]]
|
|
== Nginx module
|
|
|
|
This module periodically fetches metrics from https://nginx.org/[Nginx] servers.
|
|
|
|
The default metricset is `stubstatus`.
|
|
|
|
|
|
[float]
|
|
=== Compatibility
|
|
|
|
The Nginx metricsets were tested with Nginx 1.9 and are expected to work with all version
|
|
>= 1.9.
|
|
|
|
[float]
|
|
=== Dashboard
|
|
|
|
The nginx module comes with a predefined dashboard. For example:
|
|
|
|
image::./images/metricbeat-nginx.png[]
|
|
|
|
|
|
[float]
|
|
=== Example configuration
|
|
|
|
The Nginx module supports the standard configuration options that are described
|
|
in <<configuration-metricbeat>>. Here is an example configuration:
|
|
|
|
[source,yaml]
|
|
----
|
|
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 connections when using `ssl` config field, as described in <<configuration-ssl>>.
|
|
It also supports the options described in <<module-http-config-options>>.
|
|
|
|
[float]
|
|
=== Metricsets
|
|
|
|
The following metricsets are available:
|
|
|
|
* <<metricbeat-metricset-nginx-stubstatus,stubstatus>>
|
|
|
|
include::nginx/stubstatus.asciidoc[]
|
|
|