supervisord

README

Supervisord collector

Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems.

This module monitors one or more Supervisor instances, depending on your configuration.

It can collect metrics from both unix socket and internal http server

Used methods:

• supervisor.getAllProcessInfo

Metrics

All metrics have "supervisord." prefix.

Metric	Scope	Dimensions	Units
summary_processes	global	running, non-running	processes
processes	process group	running, non-running	processes
process_state_code	process group	a dimension per process	code
process_exit_status	process group	a dimension per process	exit status
process_uptime	process group	a dimension per process	seconds
process_downtime	process group	a dimension per process	seconds

Configuration

Edit the go.d/supervisord.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/supervisord.conf

Endpoints can be both local or remote as long as they expose their metrics on the provided URL.

Here is an example with two endpoints:

jobs:
  # via [unix_http_server]
  - name: local
    url: 'unix:///run/supervisor.sock'

  # via [inet_http_server]
  - name: local
    url: 'http://127.0.0.1:9001/RPC2'

For all available options, see the supervisord collector's configuration file.

Troubleshooting

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
  

Documentation

Index

• type Config
• type Supervisord
  • func New() *Supervisord
  • func (s *Supervisord) Charts() *module.Charts
  • func (s *Supervisord) Check() bool
  • func (s *Supervisord) Cleanup()
  • func (s *Supervisord) Collect() map[string]int64
  • func (s *Supervisord) Init() bool

Types

type Config

type Config struct {
	URL        string `yaml:"url"`
	web.Client `yaml:",inline"`
}

type Supervisord

type Supervisord struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Supervisord

func (*Supervisord) Charts

func (s *Supervisord) Charts() *module.Charts

func (*Supervisord) Check

func (s *Supervisord) Check() bool

func (*Supervisord) Cleanup

func (s *Supervisord) Cleanup()

func (*Supervisord) Collect

func (s *Supervisord) Collect() map[string]int64

func (*Supervisord) Init

func (s *Supervisord) Init() bool