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