Skip to main content

Supervisor

Plugin: go.d.plugin Module: supervisord

Overview

This collector monitors Supervisor instances.

It can collect metrics from:

Used methods:

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Supervisor instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
supervisord.summary_processesrunning, non-runningprocesses

Per process group

These metrics refer to the process group.

This scope has no labels.

Metrics:

MetricDimensionsUnit
supervisord.processesrunning, non-runningprocesses
supervisord.process_state_codea dimension per processcode
supervisord.process_exit_statusa dimension per processexit status
supervisord.process_uptimea dimension per processseconds
supervisord.process_downtimea dimension per processseconds

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is go.d/supervisord.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/supervisord.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1:9001/RPC2yes
timeoutSystem bus requests timeout.1no

Examples

HTTP

Collect metrics via HTTP.

Config
jobs:
- name: local
url: 'http://127.0.0.1:9001/RPC2'

Socket

Collect metrics via Unix socket.

Config
- name: local
url: 'unix:///run/supervisor.sock'

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collect metrics from local and remote instances.

Config
jobs:
- name: local
url: 'http://127.0.0.1:9001/RPC2'

- name: remote
url: 'http://192.0.2.1:9001/RPC2'

Troubleshooting

Debug Mode

To troubleshoot issues with the supervisord collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m supervisord

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.