Prometheus NGINX Ingress 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the prometheus-nginx-ingress monitor type to wrap the Prometheus Exporter to collect Ingress NGINX metrics for Splunk Observability Cloud.

This integration relies on the Prometheus metric implementation that replaces VTS. If you use NGINX 0.15 or lower, use the Prometheus NGINX VTS integration.

This integration is available on Linux and Windows.

Benefits 🔗

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

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Read more on how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
Learn about config options in Collector default configuration.

Example 🔗

To activate this integration, add the following to your Collector configuration:

receivers:
  smartagent/prometheus-nginx-ingress:
    type: prometheus/nginx-ingress
    discoveryRule: container_image =~ "nginx-ingress-controller" && port == 10254
    port: 10254    
    ... # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/prometheus/nginx-ingress]

Ingress NGINX configuration 🔗

Activate the controller.stats.enabled=true and controller.metrics.enabled=true flags in the NGINX Ingress Controller chart.

Configuration settings 🔗

The following table shows the configuration options for the prometheus-nginx-ingress monitor:

Option	Required	Type	Description
`httpTimeout`	No	`int64`	HTTP timeout duration for both reads and writes. Must be a duration string accepted by `ParseDuration`. Default value is `10s`.
`username`	No	`string`	Username to use on each request.
`password`	No	`string`	Password to use on each request.
`useHTTPS`	No	`bool`	If true, the agent connects to the server using HTTPS instead of plain HTTP. Default value is `false`.
`httpHeaders`	No	`map of strings`	A map of HTTP header names to values. Comma-separated multiple values for the same message-header are supported.
`skipVerify`	No	`bool`	If both `useHTTPS` and `skipVerify` are `true`, the TLS certificate of the exporter is not verified. Default value is `false`.
`caCertPath`	No	`string`	Path to the CA certificate that has signed the TLS certificate, unnecessary if `skipVerify` is set to false.
`clientCertPath`	No	`string`	Path to the client TLS certificate to use for TLS required connections.
`clientKeyPath`	No	`string`	Path to the client TLS key to use for TLS required connections.
`host`	Yes	`string`	Host of the exporter.
`port`	Yes	`integer`	Port of the exporter.
`useServiceAccount`	No	`bool`	Use pod service account to authenticate. Default value is `false`.
`metricPath`	No	`string`	Path to the metrics endpoint on the exporter server. The default value is `/metrics`.
`sendAllMetrics`	No	`bool`	Send all the metrics that come out of the Prometheus exporter without any filtering. This option has No effect when using the Prometheus exporter monitor directly, since there is No built-in filtering. Default value is `false`.

Metrics 🔗

The following metrics are available for this integration.

Notes 🔗

Learn more about the available metric types in Observability Cloud.
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about metric categories.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics using the Collector.

Troubleshooting 🔗

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

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

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

Related Topics