| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-supervisord |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: supervisord |
| 7 | monitored_instance: |
| 8 | name: Supervisor |
| 9 | link: http://supervisord.org/ |
| 10 | icon_filename: supervisord.png |
| 11 | categories: |
| 12 | - data-collection.operating-systems |
| 13 | keywords: |
| 14 | - supervisor |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: | |
| 23 | This collector monitors Supervisor instances. |
| 24 | |
| 25 | It can collect metrics from: |
| 26 | |
| 27 | - [unix socket](http://supervisord.org/configuration.html?highlight=unix_http_server#unix-http-server-section-values) |
| 28 | - [internal http server](http://supervisord.org/configuration.html?highlight=unix_http_server#inet-http-server-section-settings) |
| 29 | |
| 30 | Used methods: |
| 31 | |
| 32 | - [`supervisor.getAllProcessInfo`](http://supervisord.org/api.html#supervisor.rpcinterface.SupervisorNamespaceRPCInterface.getAllProcessInfo) |
| 33 | method_description: "" |
| 34 | supported_platforms: |
| 35 | include: [] |
| 36 | exclude: [] |
| 37 | multi_instance: true |
| 38 | additional_permissions: |
| 39 | description: "" |
| 40 | default_behavior: |
| 41 | auto_detection: |
| 42 | description: "" |
| 43 | limits: |
| 44 | description: "" |
| 45 | performance_impact: |
| 46 | description: "" |
| 47 | setup: |
| 48 | prerequisites: |
| 49 | list: [] |
| 50 | configuration: |
| 51 | file: |
| 52 | name: go.d/supervisord.conf |
| 53 | options: |
| 54 | description: | |
| 55 | The following options can be defined globally: update_every, autodetection_retry. |
| 56 | folding: |
| 57 | title: Config options |
| 58 | enabled: true |
| 59 | list: |
| 60 | - name: update_every |
| 61 | description: Data collection interval (seconds). |
| 62 | default_value: 1 |
| 63 | required: false |
| 64 | group: Collection |
| 65 | - name: autodetection_retry |
| 66 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 67 | default_value: 0 |
| 68 | required: false |
| 69 | group: Collection |
| 70 | |
| 71 | - name: url |
| 72 | description: Supervisord XML-RPC endpoint URL. |
| 73 | default_value: http://127.0.0.1:9001/RPC2 |
| 74 | required: true |
| 75 | group: Target |
| 76 | - name: timeout |
| 77 | description: Request timeout (seconds). |
| 78 | default_value: 1 |
| 79 | required: false |
| 80 | group: Target |
| 81 | |
| 82 | - name: vnode |
| 83 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 84 | default_value: "" |
| 85 | required: false |
| 86 | group: Virtual Node |
| 87 | examples: |
| 88 | folding: |
| 89 | title: Config |
| 90 | enabled: true |
| 91 | list: |
| 92 | - name: HTTP |
| 93 | description: Collect metrics via HTTP. |
| 94 | config: | |
| 95 | jobs: |
| 96 | - name: local |
| 97 | url: 'http://127.0.0.1:9001/RPC2' |
| 98 | - name: Socket |
| 99 | description: Collect metrics via Unix socket. |
| 100 | config: | |
| 101 | - name: local |
| 102 | url: 'unix:///run/supervisor.sock' |
| 103 | - name: Multi-instance |
| 104 | description: | |
| 105 | > **Note**: When you define multiple jobs, their names must be unique. |
| 106 | |
| 107 | Collect metrics from local and remote instances. |
| 108 | config: | |
| 109 | jobs: |
| 110 | - name: local |
| 111 | url: 'http://127.0.0.1:9001/RPC2' |
| 112 | |
| 113 | - name: remote |
| 114 | url: 'http://192.0.2.1:9001/RPC2' |
| 115 | troubleshooting: |
| 116 | problems: |
| 117 | list: [] |
| 118 | alerts: [] |
| 119 | metrics: |
| 120 | folding: |
| 121 | title: Metrics |
| 122 | enabled: false |
| 123 | description: "" |
| 124 | availability: [] |
| 125 | scopes: |
| 126 | - name: global |
| 127 | description: These metrics refer to the entire monitored application. |
| 128 | labels: [] |
| 129 | metrics: |
| 130 | - name: supervisord.summary_processes |
| 131 | description: Processes |
| 132 | unit: processes |
| 133 | chart_type: stacked |
| 134 | dimensions: |
| 135 | - name: running |
| 136 | - name: non-running |
| 137 | - name: process group |
| 138 | description: These metrics refer to the process group. |
| 139 | labels: [] |
| 140 | metrics: |
| 141 | - name: supervisord.processes |
| 142 | description: Processes |
| 143 | unit: processes |
| 144 | chart_type: stacked |
| 145 | dimensions: |
| 146 | - name: running |
| 147 | - name: non-running |
| 148 | - name: supervisord.process_state_code |
| 149 | description: State code |
| 150 | unit: code |
| 151 | chart_type: line |
| 152 | dimensions: |
| 153 | - name: a dimension per process |
| 154 | - name: supervisord.process_exit_status |
| 155 | description: Exit status |
| 156 | unit: exit status |
| 157 | chart_type: line |
| 158 | dimensions: |
| 159 | - name: a dimension per process |
| 160 | - name: supervisord.process_uptime |
| 161 | description: Uptime |
| 162 | unit: seconds |
| 163 | chart_type: line |
| 164 | dimensions: |
| 165 | - name: a dimension per process |
| 166 | - name: supervisord.process_downtime |
| 167 | description: Downtime |
| 168 | unit: seconds |
| 169 | chart_type: line |
| 170 | dimensions: |
| 171 | - name: a dimension per process |