Docs » Available host and application monitors » Configure application receivers for hosts and servers » Supervisor

Supervisor πŸ”—

Description πŸ”—

The Splunk Distribution of OpenTelemetry Collector provides this integration as the supervisor monitor type using the Smart Agent Receiver.

Use this integration to retrieve the state of processes running by the Supervisor.

This integration is available for Kubernetes, Windows, and Linux.

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:

Note

Provide a Supervisor monitor entry in your Collector or Smart Agent (deprecated) configuration. Use the appropriate form for your agent type.

Splunk Distribution of OpenTelemetry Collector πŸ”—

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

receivers:
  smartagent/supervisor:
    type: supervisor
    ...  # Additional config

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

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

Smart Agent πŸ”—

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
  - type: supervisor
    ...  # Additional config

See Install and configure the SignalFx Smart Agent for an autogenerated example of a YAML configuration file, with default values where applicable.

Configuration settings πŸ”—

The following table shows the configuration options for this monitor:

Option

Required

Type

Description

host

No

string

The host/IP address of the Supervisor XML-RPC API. Used to build the url option if a URL is not provided.

port

No

integer

The port of the Supervisor XML-RPC API. Used to build the url option if a URL not provided. For example, localhost. The default value is 9001.

useHTTPS

No

bool

If true, the monitor connects to the Supervisor using the HTTPS protocol instead of the HTTP protocol. The default value is false.

path

No

string

The URL path to use for the scrape URL for Supervisor. The default value is /RPC2.

url

No

string

URL on which to scrape Supervisor XML-RPC API. If this is not provided, it’s derived from the host, port, useHTTPS, and path options. For example, http://localhost:9001/RPC2.

Metrics πŸ”—

The following metrics are available for this integration:

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.