NGINX receiver 🔗

The NGINX receiver fetches stats from a NGINX instance using the ngx_http_stub_status_module module’s status endpoint. The supported pipeline type is metrics. See Process your data with pipelines for more information.

You need to configure NGINX to expose status information. To learn how, see the HTTP status module config guide in the NGINX documentation.

Note

Out-of-the-box dashboards and navigators aren’t supported for the NGINX Server receiver yet, but are planned for a future release.

Get started 🔗

Follow these steps to configure and activate the component:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the receiver as described in the next section.
Restart the Collector.

Sample configuration 🔗

To activate the NGINX receiver, add nginx to the receivers section of your configuration file, as shown in the following example:

receivers:
  nginx:
    endpoint: "http://localhost:80/status"
    collection_interval: 10s

To complete the configuration, include the receiver in the metrics pipeline of the service section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [nginx]

Configuration options 🔗

The following settings are available:

endpoint. Required. http://localhost:80/status by default. The URL of the NGINX status endpoint.

collection_interval. 10s by default. Sets the interval this receiver collects metrics on.
- This value must be a string readable by Golang’s time.ParseDuration. Learn more at Go’s official documentation ParseDuration function .
- Valid time units are ns, us (or µs), ms, s, m, h.

initial_delay. 1s by default. Determines how long this receiver waits before collecting metrics for the first time.

Settings 🔗

The following table shows the configuration options for the NGINX receiver:

Metrics 🔗

The following metrics, resource attributes, and attributes are available.

Activate or deactivate specific metrics 🔗

You can activate or deactivate specific metrics by setting the enabled field in the metrics section for each metric. For example:

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

The following is an example of host metrics receiver configuration with activated metrics:

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

Note

Deactivated metrics aren’t sent to Splunk Observability Cloud.

Billing 🔗

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

Learn more at Infrastructure Monitoring subscription usage (Host and metric plans).

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

This page was last updated on Nov 04, 2024.

Related Topics