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