summaryrefslogtreecommitdiffstats
path: root/src/collectors/windows.plugin/metadata.yaml
blob: 52694e03d7c44d96183a34306662abd04c7b332a (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
plugin_name: windows.plugin
modules:
  - meta:
      plugin_name: windows.plugin
      module_name: PerflibProcesses
      monitored_instance:
        name: System statistics
        link: "https://learn.microsoft.com/en-us/windows/win32/procthread/processes-and-threads"
        categories:
          - data-collection.windows-systems
        icon_filename: "windows.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - process counts
        - threads
        - context switch
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors the current number of processes, threads, and context switches on Windows systems.
        method_description: |
          It queries the 'System' object from Perflib in order to gather the metrics.
      supported_platforms:
        include: ["windows"]
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            The collector automatically detects all of the metrics, no further configuration is required.
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: "netdata.conf"
          section_name: "[plugin:windows]"
          description: "The Netdata main configuration file"
        options:
          description: ""
          folding:
            title: "Config option"
            enabled: false
          list:
            - name: PerflibProcesses
              description: An option to enable or disable the data collection.
              default_value: yes
              required: false
        examples:
          folding:
            enabled: true
            title: ""
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored instance."
          labels: []
          metrics:
            - name: system.processes
              description: System Processes
              unit: "processes"
              chart_type: line
              dimensions:
                - name: running
            - name: system.threads
              description: System Threads
              unit: "threads"
              chart_type: line
              dimensions:
                - name: threads
            - name: system.ctxt
              description: CPU Context Switches
              unit: "context switches/s"
              chart_type: line
              dimensions:
                - name: switches
  - meta:
      plugin_name: windows.plugin
      module_name: PerflibMemory
      monitored_instance:
        name: Memory statistics
        link: "https://learn.microsoft.com/en-us/windows/win32/Memory/memory-management"
        categories:
          - data-collection.windows-systems
        icon_filename: "windows.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - memory
        - swap
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors swap and memory pool statistics on Windows systems.
        method_description: |
          It queries for the 'Memory' object from Perflib in order to gather the metrics.
      supported_platforms:
        include: ["windows"]
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            The collector automatically detects all of the metrics, no further configuration is required.
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: "netdata.conf"
          section_name: "[plugin:windows]"
          description: "The Netdata main configuration file"
        options:
          description: ""
          folding:
            title: "Config option"
            enabled: false
          list:
            - name: PerflibMemory
              description: An option to enable or disable the data collection.
              default_value: yes
              required: false
        examples:
          folding:
            enabled: true
            title: ""
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: global
          description: "These metrics refer to the entire monitored instance"
          labels: []
          metrics:
            - name: mem.swap_iops
              description: Swap Operations
              unit: "operations/s"
              chart_type: stacked
              dimensions:
                - name: read
                - name: write
            - name: mem.swap_pages_io
              description: Swap Pages
              unit: "pages/s"
              chart_type: stacked
              dimensions:
                - name: read
                - name: write
            - name: mem.system_pool_size
              description: System Memory Pool
              unit: "bytes"
              chart_type: stacked
              dimensions:
                - name: paged
                - name: pool-paged
  - meta:
      plugin_name: windows.plugin
      module_name: PerflibThermalZone
      monitored_instance:
        name: System thermal zone
        link: "https://learn.microsoft.com/en-us/windows-hardware/design/device-experiences/design-guide"
        categories:
          - data-collection.windows-systems
        icon_filename: "windows.svg"
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      keywords:
        - thermal
        - temperature
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          This collector monitors thermal zone statistics on Windows systems.
        method_description: |
          It queries for the 'Thermal Zone Information' object from Perflib in order to gather the metrics.
      supported_platforms:
        include: ["windows"]
        exclude: []
      multi_instance: false
      additional_permissions:
        description: ""
      default_behavior:
        auto_detection:
          description: |
            The collector automatically detects all of the metrics, no further configuration is required.
        limits:
          description: ""
        performance_impact:
          description: ""
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          section_name: "[plugin:windows]"
          name: "netdata.conf"
          description: "The Netdata main configuration file."
        options:
          description: ""
          folding:
            title: "Config Option"
            enabled: false
          list:
            - name: PerflibThermalZone
              description: An option to enable or disable the data collection.
              default_value: yes
              required: false
        examples:
          folding:
            enabled: false
            title: ""
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: Thermal zone
          description: "These metrics refer to a Thermal zone"
          labels: []
          metrics:
            - name: system.thermalzone_temperature
              description: Thermal zone temperature
              unit: celsius
              chart_type: line
              dimensions:
                - name: temperature