summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/systemdunits/metadata.yaml
blob: 21755bb698dbe9cedc60be02a8cd89fe3591f476 (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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-systemdunits
      plugin_name: go.d.plugin
      module_name: systemdunits
      monitored_instance:
        name: Systemd Units
        link: https://www.freedesktop.org/wiki/Software/systemd/
        icon_filename: systemd.svg
        categories:
          - data-collection.systemd
      keywords:
        - systemd
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors Systemd units state.
        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/systemdunits.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: include
              description: Systemd units filter.
              default_value: "*.service"
              required: false
              detailed_description: |
                Systemd units matching the selector will be monitored.

                - Logic: (pattern1 OR pattern2)
                - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
                - Syntax:

                ```yaml
                includes:
                  - pattern1
                  - pattern2
                ```
            - name: timeout
              description: System bus requests timeout.
              default_value: 1
              required: false
        examples:
          folding:
            title: Config
            enabled: true
          list:
            - name: Service units
              description: Collect state of all service type units.
              config: |
                jobs:
                  - name: service
                    include:
                      - '*.service'
            - name: One specific unit
              description: Collect state of one specific unit.
              config: |
                jobs:
                  - name: my-specific-service
                    include:
                      - 'my-specific.service'
            - name: All unit types
              description: Collect state of all units.
              config: |
                jobs:
                  - name: my-specific-service-unit
                    include:
                      - '*'
            - name: Multi-instance
              description: |
                > **Note**: When you define multiple jobs, their names must be unique.
                
                Collect state of all service and socket type units.
              config: |
                jobs:
                  - name: service
                    include:
                      - '*.service'
                
                  - name: socket
                    include:
                      - '*.socket'
    troubleshooting:
      problems:
        list: []
    alerts:
      - name: systemd_service_unit_failed_state
        metric: systemd.service_unit_state
        info: systemd service unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_socket_unit_failed_state
        metric: systemd.socket_unit_state
        info: systemd socket unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_target_unit_failed_state
        metric: systemd.target_unit_state
        info: systemd target unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_path_unit_failed_state
        metric: systemd.path_unit_state
        info: systemd path unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_device_unit_failed_state
        metric: systemd.device_unit_state
        info: systemd device unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_mount_unit_failed_state
        metric: systemd.mount_unit_state
        info: systemd mount unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_automount_unit_failed_state
        metric: systemd.automount_unit_state
        info: systemd automount unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_swap_unit_failed_state
        metric: systemd.swap_unit_state
        info: systemd swap unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_scope_unit_failed_state
        metric: systemd.scope_unit_state
        info: systemd scope unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_slice_unit_failed_state
        metric: systemd.slice_unit_state
        info: systemd slice unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
      - name: systemd_timer_unit_failed_state
        metric: systemd.timer_unit_state
        info: systemd timer unit in the failed state
        link: https://github.com/netdata/netdata/blob/master/src/health/health.d/systemdunits.conf
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: unit
          description: These metrics refer to the systemd unit.
          labels:
            - name: unit_name
              description: systemd unit name
          metrics:
            - name: systemd.service_unit_state
              description: Service Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.socket_unit_state
              description: Socket Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.target_unit_state
              description: Target Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.path_unit_state
              description: Path Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.device_unit_state
              description: Device Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.mount_unit_state
              description: Mount Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.automount_unit_state
              description: Automount Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.swap_unit_state
              description: Swap Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.timer_unit_state
              description: Timer Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.scope_unit_state
              description: Scope Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed
            - name: systemd.slice_unit_state
              description: Slice Unit State
              unit: state
              chart_type: line
              dimensions:
                - name: active
                - name: inactive
                - name: activating
                - name: deactivating
                - name: failed