Fill in metadata for idlejitter plugin. (#15506)
* Fill in metadata for idlejitter plugin. * Fix typos. * Apply suggestions from code review Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud> --------- Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud>
Austin S. Hemmelgarn committed
Jul 25, 2023 at 07:21 UTC
906be52c042362114b0da42f9625d9011f238858
1 file changed
+37
-23
collectors/idlejitter.plugin/metadata.yaml
+37
-23
@@ -2,31 +2,38 @@ meta:
2
plugin_name: idlejitter.plugin
3
module_name: idlejitter.plugin
4
monitored_instance:
5
- name: IdleJitter
5
+ name: Idle OS Jitter
6
link: ''
7
categories:
8
- - data-collection.synthetic-checks
8
+ - data-collection.synthetic-checks
9
icon_filename: 'syslog.png'
10
related_resources:
11
integrations:
12
list: []
13
info_provided_to_referring_integrations:
14
description: ''
15
- keywords: []
15
+ keywords:
16
+ - latency
17
+ - jitter
18
most_popular: false
19
overview:
20
data_collection:
19
- metrics_description: 'Monitor IdleJitter performance for optimal system idle process operations. Monitor CPU idle times, wake-ups, and power states to optimize system resource usage.'
20
- method_description: ''
21
+ metrics_description: >
22
+ Monitor delays in timing for user processes caused by scheduling limitations to optimize the system to run
23
+ latency sensitive applications with minimal jitter, improving consistency and quality of service.
24
+ method_description: >
25
+ A thread is spawned that requests to sleep for fixed amount of time. When the system wakes it up, it
26
+ measures how many microseconds have passed. The difference between the requested and the actual duration of
27
+ the sleep, is the idle jitter. This is done dozens of times per second to ensure we have a representative sample.
28
supported_platforms:
29
include: []
30
exclude: []
24
- multi_instance: true
31
+ multi_instance: false
32
additional_permissions:
33
description: ''
34
default_behavior:
35
auto_detection:
29
- description: ''
36
+ description: 'This integration will run by default on all supported systems.'
37
limits:
38
description: ''
39
performance_impact:
@@ -36,14 +43,21 @@ setup:
43
list: []
44
configuration:
45
file:
39
- name: ''
46
+ name: 'netdata.conf'
47
+ section: 'plugin:idlejitter'
48
description: ''
49
options:
42
- description: ''
50
+ description: >
51
+ This integration only supports a single configuration option, and most users will not need to change it.
52
folding:
53
title: ''
45
- enabled: true
46
- list: []
54
+ enabled: false
55
+ list:
56
+ - name: loop time in ms
57
+ description: >
58
+ Specifies the target time for the data collection thread to sleep, measured in miliseconds.
59
+ default: 20
60
+ required: false
61
examples:
62
folding:
63
enabled: true
@@ -60,15 +74,15 @@ metrics:
74
description: ""
75
availability: []
76
scopes:
63
- - name: global
64
- description: ""
65
- labels: []
66
- metrics:
67
- - name: system.idlejitter
68
- description: CPU Idle Jitter
69
- unit: "microseconds lost/s"
70
- chart_type: line
71
- dimensions:
72
- - name: min
73
- - name: max
74
- - name: average
77
+ - name: global
78
+ description: ""
79
+ labels: []
80
+ metrics:
81
+ - name: system.idlejitter
82
+ description: CPU Idle Jitter
83
+ unit: "microseconds lost/s"
84
+ chart_type: line
85
+ dimensions:
86
+ - name: min
87
+ - name: max
88
+ - name: average