Docs » Available host and application monitors » Configure application receivers for hosts and servers » NGINX

NGINX 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the nginx monitor type by using the SignalFx Smart Agent Receiver.

Use this integration to retrieve metrics and logs from an NGINX instance.

Note

This monitor is not available on Windows.

Benefits 🔗

After you configure the integration, you can access these features:

Installation 🔗

Follow these steps to deploy this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the Configuration section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor type is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. You can use existing Smart Agent monitors as OpenTelemetry Collector metric receivers with the Smart Agent Receiver.

This monitor type requires a properly configured environment on your system in which you’ve installed a functional Smart Agent release bundle. The Collector provides this bundle in the installation paths for x86_64/amd64.

To activate this monitor type in the Collector, add the following lines to your configuration (YAML) file:

Note

Provide an NGINX monitor entry in your Smart Agent or Collector configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/nginx:
    type: collectd/nginx
    ...  # Additional config

To complete the monitor activation, you must also include the smartagent/nginx receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/nginx]
    logs:
      receivers: [smartagent/nginx]

Note

Configure NGINX to expose status information by editing the NGINX configuration. See ngx_http_stub_status_module on the NGINX documentation site.

Smart Agent 🔗

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

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

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

host

Yes

string

Hostname or IP address of the NGINX instance. For example, 127.0.0.1.

port

Yes

integer

The port of the NGINX instance. For example, 8080.

name

no

string

Name of the NGINX instance.

url

no

string

URL of the status endpoint. The default value is http://{{.Host}}:{{.Port}}/nginx_status, which takes the values defined in host and port.

username

no

string

Username for HTTP basic authentication, if needed.

password

no

string

Password for HTTP basic authentication, if needed.

timeout

no

integer

Timeout in seconds for the request. The default value is 0.

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

To learn about even more support options, see Splunk Customer Success.