Monitor Type: supervisor (Source)
Accepts Endpoints: No
Multiple Instances Allowed: Yes
This monitor will retrieve state of processes running by Supervisor.
To activate this monitor in the Smart Agent, add the following to your agent config:
monitors: # All monitor config goes under this key
- type: supervisor
... # Additional config
For a list of monitor options that are common to all monitors, see Common Configuration.
| Config option | Required | Type | Description |
|---|---|---|---|
host |
no | string |
The host/ip address of the Supervisor XML-RPC API. This is used to construct the url option if not provided. |
port |
no | integer |
The port of the Supervisor XML-RPC API. This is used to construct the url option if not provided. (i.e. localhost) (default: 9001) |
useHTTPS |
no | bool |
If true, the monitor will connect to Supervisor via HTTPS instead of HTTP. (default: false) |
path |
no | string |
The URL path to use for the scrape URL for Supervisor. (default: /RPC2) |
url |
no | string |
URL on which to scrape Supervisor XML-RPC API. If this is not provided, it will be derive from the host, port, useHTTPS, and path options. (i.e. http://localhost:9001/RPC2) |
These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.
supervisor.state(gauge)
State code, see Supervisor process states.
To emit metrics that are not default, you can add those metrics in the
generic monitor-level extraMetrics config option. Metrics that are derived
from specific configuration options that do not appear in the above list of
metrics do not need to be added to extraMetrics.
To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.
The following dimensions may occur on metrics emitted by this monitor. Some dimensions may be specific to certain metrics.
| Name | Description |
|---|---|
group |
Name of the process group. |
name |
Name of the process. |