github.com/netdata/go.d.plugin@v0.58.1/modules/supervisord/metadata.yaml (about)

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