Docs » Available host and application monitors » Configure application exporters and receivers for monitoring » Prometheus Go

Prometheus Go πŸ”—

Description πŸ”—

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

This monitor wraps the Prometheus Exporter to scrape Prometheus Go collector and Prometheus process collector metrics for Splunk Observability Cloud.

This monitor 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:

  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:

receivers:
  smartagent/prometheus-go:
    type: prometheus-go
    host: localhost
    port: 2112
    ... # 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-go]

Configuration settings πŸ”—

The following table shows the configuration options for the prometheus-go 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.

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.