summaryrefslogtreecommitdiffstats
path: root/collectors/idlejitter.plugin
diff options
context:
space:
mode:
authorAustin S. Hemmelgarn <austin@netdata.cloud>2023-07-25 07:21:55 -0400
committerGitHub <noreply@github.com>2023-07-25 07:21:55 -0400
commit906be52c042362114b0da42f9625d9011f238858 (patch)
treef61fc2c691ec2e44b217aac29884d3860f619b2c /collectors/idlejitter.plugin
parent4774907feb4528264a607164879ed2431f1a94bb (diff)
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>
Diffstat (limited to 'collectors/idlejitter.plugin')
-rw-r--r--collectors/idlejitter.plugin/metadata.yaml60
1 files changed, 37 insertions, 23 deletions
diff --git a/collectors/idlejitter.plugin/metadata.yaml b/collectors/idlejitter.plugin/metadata.yaml
index b3f255b9de..b489125d2d 100644
--- a/collectors/idlejitter.plugin/metadata.yaml
+++ b/collectors/idlejitter.plugin/metadata.yaml
@@ -2,31 +2,38 @@ meta:
plugin_name: idlejitter.plugin
module_name: idlejitter.plugin
monitored_instance:
- name: IdleJitter
+ name: Idle OS Jitter
link: ''
categories:
- - data-collection.synthetic-checks
+ - data-collection.synthetic-checks
icon_filename: 'syslog.png'
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ''
- keywords: []
+ keywords:
+ - latency
+ - jitter
most_popular: false
overview:
data_collection:
- 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.'
- method_description: ''
+ metrics_description: >
+ 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.
+ method_description: >
+ 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.
supported_platforms:
include: []
exclude: []
- multi_instance: true
+ multi_instance: false
additional_permissions:
description: ''
default_behavior:
auto_detection:
- description: ''
+ description: 'This integration will run by default on all supported systems.'
limits:
description: ''
performance_impact:
@@ -36,14 +43,21 @@ setup:
list: []
configuration:
file:
- name: ''
+ name: 'netdata.conf'
+ section: 'plugin:idlejitter'
description: ''
options:
- description: ''
+ description: >
+ This integration only supports a single configuration option, and most users will not need to change it.
folding:
title: ''
- enabled: true
- list: []
+ enabled: false
+ list:
+ - name: loop time in ms
+ description: >
+ Specifies the target time for the data collection thread to sleep, measured in miliseconds.
+ default: 20
+ required: false
examples:
folding:
enabled: true
@@ -60,15 +74,15 @@ metrics:
description: ""
availability: []
scopes:
- - name: global
- description: ""
- labels: []
- metrics:
- - name: system.idlejitter
- description: CPU Idle Jitter
- unit: "microseconds lost/s"
- chart_type: line
- dimensions:
- - name: min
- - name: max
- - name: average
+ - name: global
+ description: ""
+ labels: []
+ metrics:
+ - name: system.idlejitter
+ description: CPU Idle Jitter
+ unit: "microseconds lost/s"
+ chart_type: line
+ dimensions:
+ - name: min
+ - name: max
+ - name: average