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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-systemdunits
     5        plugin_name: go.d.plugin
     6        module_name: systemdunits
     7        monitored_instance:
     8          name: Systemd Units
     9          link: https://www.freedesktop.org/wiki/Software/systemd/
    10          icon_filename: systemd.svg
    11          categories:
    12            - data-collection.systemd
    13        keywords:
    14          - systemd
    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 Systemd units state.
    25          method_description: ""
    26        supported_platforms:
    27          include: []
    28          exclude: []
    29        multi_instance: true
    30        additional_permissions:
    31          description: ""
    32        default_behavior:
    33          auto_detection:
    34            description: ""
    35          limits:
    36            description: ""
    37          performance_impact:
    38            description: ""
    39      setup:
    40        prerequisites:
    41          list: []
    42        configuration:
    43          file:
    44            name: go.d/systemdunits.conf
    45          options:
    46            description: |
    47              The following options can be defined globally: update_every, autodetection_retry.
    48            folding:
    49              title: Config options
    50              enabled: true
    51            list:
    52              - name: update_every
    53                description: Data collection frequency.
    54                default_value: 1
    55                required: false
    56              - name: autodetection_retry
    57                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    58                default_value: 0
    59                required: false
    60              - name: include
    61                description: Systemd units filter.
    62                default_value: "*.service"
    63                required: false
    64                detailed_description: |
    65                  Systemd units matching the selector will be monitored.
    66  
    67                  - Logic: (pattern1 OR pattern2)
    68                  - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
    69                  - Syntax:
    70  
    71                  ```yaml
    72                  includes:
    73                    - pattern1
    74                    - pattern2
    75                  ```
    76              - name: timeout
    77                description: System bus requests timeout.
    78                default_value: 1
    79                required: false
    80          examples:
    81            folding:
    82              title: Config
    83              enabled: true
    84            list:
    85              - name: Service units
    86                description: Collect state of all service type units.
    87                config: |
    88                  jobs:
    89                    - name: service
    90                      include:
    91                        - '*.service'
    92              - name: One specific unit
    93                description: Collect state of one specific unit.
    94                config: |
    95                  jobs:
    96                    - name: my-specific-service
    97                      include:
    98                        - 'my-specific.service'
    99              - name: All unit types
   100                description: Collect state of all units.
   101                config: |
   102                  jobs:
   103                    - name: my-specific-service-unit
   104                      include:
   105                        - '*'
   106              - name: Multi-instance
   107                description: |
   108                  > **Note**: When you define multiple jobs, their names must be unique.
   109                  
   110                  Collect state of all service and socket type units.
   111                config: |
   112                  jobs:
   113                    - name: service
   114                      include:
   115                        - '*.service'
   116                  
   117                    - name: socket
   118                      include:
   119                        - '*.socket'
   120      troubleshooting:
   121        problems:
   122          list: []
   123      alerts:
   124        - name: systemd_service_unit_failed_state
   125          metric: systemd.service_unit_state
   126          info: systemd service unit in the failed state
   127          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   128        - name: systemd_socket_unit_failed_state
   129          metric: systemd.socket_unit_state
   130          info: systemd socket unit in the failed state
   131          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   132        - name: systemd_target_unit_failed_state
   133          metric: systemd.target_unit_state
   134          info: systemd target unit in the failed state
   135          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   136        - name: systemd_path_unit_failed_state
   137          metric: systemd.path_unit_state
   138          info: systemd path unit in the failed state
   139          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   140        - name: systemd_device_unit_failed_state
   141          metric: systemd.device_unit_state
   142          info: systemd device unit in the failed state
   143          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   144        - name: systemd_mount_unit_failed_state
   145          metric: systemd.mount_unit_state
   146          info: systemd mount unit in the failed state
   147          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   148        - name: systemd_automount_unit_failed_state
   149          metric: systemd.automount_unit_state
   150          info: systemd automount unit in the failed state
   151          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   152        - name: systemd_swap_unit_failed_state
   153          metric: systemd.swap_unit_state
   154          info: systemd swap unit in the failed state
   155          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   156        - name: systemd_scope_unit_failed_state
   157          metric: systemd.scope_unit_state
   158          info: systemd scope unit in the failed state
   159          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   160        - name: systemd_slice_unit_failed_state
   161          metric: systemd.slice_unit_state
   162          info: systemd slice unit in the failed state
   163          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   164        - name: systemd_timer_unit_failed_state
   165          metric: systemd.timer_unit_state
   166          info: systemd timer unit in the failed state
   167          link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
   168      metrics:
   169        folding:
   170          title: Metrics
   171          enabled: false
   172        description: ""
   173        availability: []
   174        scopes:
   175          - name: unit
   176            description: These metrics refer to the systemd unit.
   177            labels:
   178              - name: unit_name
   179                description: systemd unit name
   180            metrics:
   181              - name: systemd.service_unit_state
   182                description: Service Unit State
   183                unit: state
   184                chart_type: line
   185                dimensions:
   186                  - name: active
   187                  - name: inactive
   188                  - name: activating
   189                  - name: deactivating
   190                  - name: failed
   191              - name: systemd.socket_unit_state
   192                description: Socket Unit State
   193                unit: state
   194                chart_type: line
   195                dimensions:
   196                  - name: active
   197                  - name: inactive
   198                  - name: activating
   199                  - name: deactivating
   200                  - name: failed
   201              - name: systemd.target_unit_state
   202                description: Target Unit State
   203                unit: state
   204                chart_type: line
   205                dimensions:
   206                  - name: active
   207                  - name: inactive
   208                  - name: activating
   209                  - name: deactivating
   210                  - name: failed
   211              - name: systemd.path_unit_state
   212                description: Path Unit State
   213                unit: state
   214                chart_type: line
   215                dimensions:
   216                  - name: active
   217                  - name: inactive
   218                  - name: activating
   219                  - name: deactivating
   220                  - name: failed
   221              - name: systemd.device_unit_state
   222                description: Device Unit State
   223                unit: state
   224                chart_type: line
   225                dimensions:
   226                  - name: active
   227                  - name: inactive
   228                  - name: activating
   229                  - name: deactivating
   230                  - name: failed
   231              - name: systemd.mount_unit_state
   232                description: Mount Unit State
   233                unit: state
   234                chart_type: line
   235                dimensions:
   236                  - name: active
   237                  - name: inactive
   238                  - name: activating
   239                  - name: deactivating
   240                  - name: failed
   241              - name: systemd.automount_unit_state
   242                description: Automount Unit State
   243                unit: state
   244                chart_type: line
   245                dimensions:
   246                  - name: active
   247                  - name: inactive
   248                  - name: activating
   249                  - name: deactivating
   250                  - name: failed
   251              - name: systemd.swap_unit_state
   252                description: Swap Unit State
   253                unit: state
   254                chart_type: line
   255                dimensions:
   256                  - name: active
   257                  - name: inactive
   258                  - name: activating
   259                  - name: deactivating
   260                  - name: failed
   261              - name: systemd.timer_unit_state
   262                description: Timer Unit State
   263                unit: state
   264                chart_type: line
   265                dimensions:
   266                  - name: active
   267                  - name: inactive
   268                  - name: activating
   269                  - name: deactivating
   270                  - name: failed
   271              - name: systemd.scope_unit_state
   272                description: Scope Unit State
   273                unit: state
   274                chart_type: line
   275                dimensions:
   276                  - name: active
   277                  - name: inactive
   278                  - name: activating
   279                  - name: deactivating
   280                  - name: failed
   281              - name: systemd.slice_unit_state
   282                description: Slice Unit State
   283                unit: state
   284                chart_type: line
   285                dimensions:
   286                  - name: active
   287                  - name: inactive
   288                  - name: activating
   289                  - name: deactivating
   290                  - name: failed