Docs » Configure application receivers » Configure application receivers for monitoring » Prometheus NGINX VTS

Prometheus NGINX VTS 🔗

Description 🔗

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

This monitor wraps the Prometheus Exporter to scrape Prometheus NGINX VTS exporter metrics for Splunk Observability Cloud.

This receiver is available on Linux and Windows.

Benefits 🔗

After you’ve configured the integration, you can:

  • View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy the integration:

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

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

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver lets you use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

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

receivers:
  smartagent/prometheus-nginx-vts:
    type: prometheus-nginx-vts
    ... # Additional config

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

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

Configuration settings 🔗

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

Option Required Type Description
httpTimeout no int64 HTTP timeout duration for both reads and writes. Must be a duration string accepted by https://golang.org/pkg/time/#ParseDuration. Default value is 10s.
username no string User name 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.

Non-default metrics (version 4.7.0+) 🔗

To emit metrics that are not default, you can add those metrics in the generic receiver-level extraMetrics config option. You don’t need to add to extraMetrics any metric derived from configuration options that don’t appear in the list of metrics.

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

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud:

  • Ask questions and get answers through community support at Splunk Answers.

  • If you have a support contract, file a case using the Splunk Support Portal. See Support and Services.

  • To get professional help with optimizing your Splunk software investment, see Splunk Services.