Add Objects metadata (Windows Plugin) (#19175)
* objects_metadata: Add Objects metadata to Windows.plugin * update --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
thiagoftsm committed
Dec 10, 2024 at 08:45 UTC
c0a6c4c93eb4473b879460082af32e03bdb0c35f
1 file changed
+88
-2
src/collectors/windows.plugin/metadata.yaml
+88
-2
@@ -179,7 +179,7 @@ modules:
179
availability: []
180
scopes:
181
- name: global
182
- description: "These metrics refer to the entire monitored instance"
182
+ description: "These metrics refer to the entire system."
183
labels: []
184
metrics:
185
- name: mem.swap_iops
@@ -277,7 +277,7 @@ modules:
277
availability: []
278
scopes:
279
- name: global
280
- description: "These metrics refer to the entire monitored instance."
280
+ description: "These metrics refer to the entire system."
281
labels: []
282
metrics:
283
- name: system.processes
@@ -298,6 +298,92 @@ modules:
298
chart_type: line
299
dimensions:
300
- name: switches
301
+ - meta:
302
+ plugin_name: windows.plugin
303
+ module_name: PerflibObjects
304
+ monitored_instance:
305
+ name: Semaphore statistics
306
+ link: "https://learn.microsoft.com/en-us/windows/win32/sync/semaphore-objects"
307
+ categories:
308
+ - data-collection.windows-systems
309
+ icon_filename: "windows.svg"
310
+ related_resources:
311
+ integrations:
312
+ list: []
313
+ info_provided_to_referring_integrations:
314
+ description: ""
315
+ keywords:
316
+ - ipc
317
+ - semaphores
318
+ most_popular: false
319
+ overview:
320
+ data_collection:
321
+ metrics_description: |
322
+ Inter-Process Communication (IPC) enables different processes to communicate and coordinate with each other. This collector monitors IPC semaphores, which are synchronization tools that:
323
+
324
+ - Control access to shared resources (like files, memory, or devices).
325
+ - Ensure only one process can access a resource at a time.
326
+ - Prevent conflicts between competing processes.
327
+ method_description: |
328
+ It queries for the 'Objects' object from Perflib in order to gather the metrics.
329
+ supported_platforms:
330
+ include: ["windows"]
331
+ exclude: []
332
+ multi_instance: false
333
+ additional_permissions:
334
+ description: ""
335
+ default_behavior:
336
+ auto_detection:
337
+ description: |
338
+ The collector automatically detects all of the metrics, no further configuration is required.
339
+ limits:
340
+ description: ""
341
+ performance_impact:
342
+ description: ""
343
+ setup:
344
+ prerequisites:
345
+ list: []
346
+ configuration:
347
+ file:
348
+ name: "netdata.conf"
349
+ section_name: "[plugin:windows]"
350
+ description: "The Netdata main configuration file"
351
+ options:
352
+ description: ""
353
+ folding:
354
+ title: "Config option"
355
+ enabled: false
356
+ list:
357
+ - name: PerflibObjects
358
+ description: An option to enable or disable the data collection.
359
+ default_value: yes
360
+ required: false
361
+ examples:
362
+ folding:
363
+ enabled: true
364
+ title: ""
365
+ list: []
366
+ troubleshooting:
367
+ problems:
368
+ list: []
369
+ alerts: []
370
+ metrics:
371
+ folding:
372
+ title: Metrics
373
+ enabled: false
374
+ description: ""
375
+ availability: []
376
+ scopes:
377
+ - name: global
378
+ description: "These metrics refer to the entire system."
379
+ labels: []
380
+ metrics:
381
+ - name: system.ipc_semaphores
382
+ description: IPC Semaphores
383
+ unit: "semaphores"
384
+ chart_type: area
385
+ dimensions:
386
+ - name: semaphores
387
- meta:
388
plugin_name: windows.plugin
389
module_name: PerflibThermalZone