Docs » Integrations Guide » Use the Smart Agent » Monitors » collectd/nginx

collectd/nginx 🔗

Monitor Type: collectd/nginx (Source)

Accepts Endpoints: Yes

Multiple Instances Allowed: Yes

Overview 🔗

Monitors an NGINX instance using our fork of the collectd nginx plugin based on the collectd nginx plugin.

Note that this montior requires special configuration enabled in NGINX (see Setup).

NGINX-specific configuration 🔗

You must configure NGINX to expose status information by editing the NGINX configuration. Please see ngx_http_stub_status_module for a guide to configuring the NGINX stats module ngx_http_stub_status_module.

Configuration 🔗

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: collectd/nginx
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
host yes string
port yes integer
name no string
url no string The full URL of the status endpoint; can be a template (default: http://{{.Host}}:{{.Port}}/nginx_status)
username no string
password no string
timeout no integer (default: 0)

Metrics 🔗

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • connections.accepted (cumulative)
    Connections accepted by NGINX Web Server
  • connections.failed (cumulative)
    Connections failed by the NGINX Web Server
  • connections.handled (cumulative)
    Connections handled by NGINX Web Server
  • (gauge)
    Connections active in NGINX Web Server
  • nginx_connections.reading (gauge)
    Connections being read by NGINX Web Server
  • nginx_connections.waiting (gauge)
    Connections waited on by NGINX Web Server
  • nginx_connections.writing (gauge)
    Connections being written by NGINX Web Server
  • nginx_requests (cumulative)
    Requests handled by NGINX Web Server

Non-default metrics (version 4.7.0+) 🔗

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.