Supervisor Input Plugin

This plugin gathers information about processes running under supervisord using the XML-RPC API.

Introduced in: Telegraf v1.24.0 Tags: applications OS support: all

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Gathers information about processes that running under supervisor using XML-RPC API
[[inputs.supervisor]]
  ## Url of supervisor's XML-RPC endpoint if basic auth enabled in supervisor http server,
  ## than you have to add credentials to url (ex. http://login:pass@localhost:9001/RPC2)
  # url="http://localhost:9001/RPC2"
  ## With settings below you can manage gathering additional information about processes
  ## If both of them empty, then all additional information will be collected.
  ## Currently supported supported additional metrics are: pid, rc
  # metrics_include = []
  # metrics_exclude = ["pid", "rc"]

Supervisor configuration

This plugin needs an HTTP server to be enabled in supervisor. It is recommended to enable basic authentication on the HTTP server. When using basic authentication make sure to include the username and password in the plugin’s url setting. Here is an example of the inet_http_server section in supervisor’s config that will work with default plugin configuration:

[inet_http_server]
port = 127.0.0.1:9001
username = user
password = pass

Optional metrics

You can control gathering of some supervisor’s metrics (processes PIDs and exit codes) by setting metrics_include and metrics_exclude parameters in configuration file.

Server tag

Server tag is used to identify metrics source server. You have an option to use host:port pair of supervisor’s http endpoint by default or you can use supervisor’s identification string, which is set in supervisor’s configuration file.

Metrics

• supervisor_processes

  • Tags:
    • source (Hostname or IP address of supervisor’s instance)
    • port (Port number of supervisor’s HTTP server)
    • id (Supervisor’s identification string)
    • name (Process name)
    • group (Process group)
  • Fields:
    • state (int, see reference)
    • uptime (int, seconds)
    • pid (int, optional)
    • exitCode (int, optional)

• supervisor_instance

  • Tags:
    • source (Hostname or IP address of supervisor’s instance)
    • port (Port number of supervisor’s HTTP server)
    • id (Supervisor’s identification string)
  • Fields:
    • state (int, see reference)

Supervisor process state field reference table

Supervisor instance state field reference

Example Output

supervisor_processes,group=ExampleGroup,id=supervisor,port=9001,process=ExampleProcess,source=localhost state=20i,uptime=75958i 1659786637000000000
supervisor_instance,id=supervisor,port=9001,source=localhost state=1i 1659786637000000000