@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 124 lines 3.29 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/idlejitter.plugin/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/idlejitter.plugin/metadata.yaml"
4 sidebar_label: "Idle OS Jitter"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Synthetic Testing"
7 keywords: ['latency', 'jitter']
8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9 endmeta-->
10
11 # Idle OS Jitter
12
13
14 <img src="https://netdata.cloud/img/syslog.png" width="150"/>
15
16
17 Plugin: idlejitter.plugin
18 Module: idlejitter.plugin
19
20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22 ## Overview
23
24 Monitor delays in timing for user processes caused by scheduling limitations to optimize the system to run latency sensitive applications with minimal jitter, improving consistency and quality of service.
25
26
27 A thread is spawned that requests to sleep for fixed amount of time. When the system wakes it up, it measures how many microseconds have passed. The difference between the requested and the actual duration of the sleep, is the idle jitter. This is done dozens of times per second to ensure we have a representative sample.
28
29
30 This collector is supported on all platforms.
31
32 This collector only supports collecting metrics from a single instance of this integration.
33
34
35 ### Default Behavior
36
37 #### Auto-Detection
38
39 This integration will run by default on all supported systems.
40
41 #### Limits
42
43 The default configuration for this integration does not impose any limits on data collection.
44
45 #### Performance Impact
46
47 The default configuration for this integration is not expected to impose a significant performance impact on the system.
48
49 ## Setup
50
51
52 ### Prerequisites
53
54 No action required.
55
56 ### Configuration
57
58 #### Options
59
60 This integration only supports a single configuration option, and most users will not need to change it.
61
62
63
64
65 | Option | Description | Default | Required |
66 |:-----|:------------|:--------|:---------:|
67 | loop time | Specifies the target time for the data collection thread to sleep, measured in miliseconds. | 20ms | no |
68
69
70
71
72 #### via File
73
74 The configuration file name for this integration is `netdata.conf`.
75
76 The file format is a modified INI syntax. The general structure is:
77
78 ```ini
79 [section1]
80 option1 = some value
81 option2 = some other value
82
83 [section2]
84 option3 = some third value
85 ```
86 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
87 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
88
89 ```bash
90 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
91 sudo ./edit-config netdata.conf
92 ```
93
94 ##### Examples
95 There are no configuration examples.
96
97
98
99 ## Alerts
100
101 There are no alerts configured by default for this integration.
102
103
104 ## Metrics
105
106 Metrics grouped by *scope*.
107
108 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
109
110
111
112 ### Per Idle OS Jitter instance
113
114
115
116 This scope has no labels.
117
118 Metrics:
119
120 | Metric | Dimensions | Unit |
121 |:------|:----------|:----|
122 | system.idlejitter | min, max, average | microseconds lost/s |
123
124