netdata/collectors/idlejitter.plugin/metadata.yaml

plugin_name: idlejitter.plugin
modules:
  - meta:
      plugin_name: idlejitter.plugin
      module_name: idlejitter.plugin
      monitored_instance:
        name: Idle OS Jitter
        link: ''
        categories:
          - data-collection.synthetic-checks
        icon_filename: 'syslog.png'
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ''
      keywords:
        - latency
        - jitter
      most_popular: false
    overview:
      data_collection:
        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: false
      additional_permissions:
        description: ''
      default_behavior:
        auto_detection:
          description: 'This integration will run by default on all supported systems.'
        limits:
          description: ''
        performance_impact:
          description: ''
    setup:
      prerequisites:
        list: []
      configuration:
        file:
          name: 'netdata.conf'
          section: 'plugin:idlejitter'
          description: ''
        options:
          description: >
            This integration only supports a single configuration option, and most users will not need to change it.
          folding:
            title: ''
            enabled: false
          list:
            - name: loop time in ms
              description: >
                Specifies the target time for the data collection thread to sleep, measured in miliseconds.
              default_value: 20
              required: false
        examples:
          folding:
            enabled: true
            title: ''
          list: []
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      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