Docs » Available host and application monitors » Configure application receivers for databases » Consul datastore

Consul datastore 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the Consul datastore monitor type to monitor Consul datastores and collect metrics from the following endpoints:

This integration is only available on Kubernetes and Linux.

This integration works with Consul 0.7.0 and higher.

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 🔗

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

  1. Include the Smart Agent receiver in your configuration file.

  2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

Example 🔗

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

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

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

service:
  pipelines:
    metrics:
      receivers: [smartagent/consul]

Configuration options 🔗

If you are running a version of Consul earlier than 0.9.1, configure each Consul agent you want to monitor to send metrics to the OpenTelemetry Collector. To do so, add the following configuration to each Consul agent configuration file:

{"telemetry":
   {"statsd_address": "<agent host>:<agent port, default 8125>"}
}

Configuration settings 🔗

The following table shows the configuration options for this integration:

Option

Required

Type

Description

pythonBinary

no

string

Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.

host

yes

string

port

yes

integer

aclToken

no

string

Consul ACL token

useHTTPS

no

bool

Set to true to connect to Consul using HTTPS. You can figure the certificate for the server with the caCertificate config option. (default: false)

telemetryServer

no

bool

(default: false)

telemetryHost

no

string

IP address or DNS to which Consul is configured to send telemetry UDP packets. Relevant only if telemetryServer is set to true. (default: 0.0.0.0)

telemetryPort

no

integer

Port to which Consul is configured to send telemetry UDP packets. Relevant only if telemetryServer is set to true. (default: 8125)

enhancedMetrics

no

bool

Set to true to activate the collection all metrics from Consul runtime telemetry send using UDP or from the /agent/metrics endpoint. (default: false)

caCertificate

no

string

If Consul server has HTTPS activated for the API, specifies the path to the CA Certificate.

clientCertificate

no

string

If client-side authentication is activated, specifies the path to the certificate file.

clientKey

no

string

If client-side authentication is activated, specifies the path to the key file.

signalFxAccessToken

no

string

Metrics 🔗

These metrics are available for this integration.

Notes 🔗

  • Learn more about the available metric types in Observability Cloud.

  • 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.

  • 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:

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