Project: Netdata (Observability and Analysis / Observability)
File: supervisor.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/supervisord/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/supervisord/metadata.yaml" sidebar_label: "Supervisor" learn_status: "Published" learnrelpath: "Collecting Metrics/Processes and System Services" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/supervisord.png" width="150"/> Plugin: go.d.plugin Module: supervisord <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | supervisord.summary_processes | running, non-running | processes | These metrics refer to the process group. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | supervisord.processes | running, non-running | processes | | supervisord.processstatecode | a dimension per process | code | | supervisord.processexitstatus | a dimension per process | exit status | | supervisord.process_uptime | a dimension per process | seconds | | supervisord.process_downtime | a dimension per process | seconds | There are no alerts configured by default for this integration. No action required. 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/supervisord.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1:9001/RPC2 | yes | | timeout | System bus requests timeout. | 1 | no | </details> Collect metrics via HTTP. <details><summary>Config</summary> ```yaml jobs: name: local url: 'http://127.0.0.1:9001/RPC2' ``` </details> Collect metrics via Unix socket. <details><summary>Config</summary> ```yaml name: local url: 'unix:///run/supervisor.sock' ``` </details> Note: When you define multiple jobs, their names must be unique. Collect metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local url: 'http://127.0.0.1:9001/RPC2' name: remote url: 'http://192.0.2.1:9001/RPC2' ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m supervisord ```