diff options
author | thiagoftsm <thiagoftsm@gmail.com> | 2023-07-28 18:44:12 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-28 21:44:12 +0300 |
commit | 0f8e4d4eb698a7cea8990dd90d87792515aebbf1 (patch) | |
tree | 2c091b2db0dae9f3238a71b88f6c37b97a7e274a /collectors | |
parent | 6e29b37466f15e7630fa37d693d520b49cb75513 (diff) |
Debugfs yaml update (#15633)
* debufs_yaml: Initial code for debugs.
* debufs_yaml: Update second module for debugfs
* debufs_yaml: Add missing module
Diffstat (limited to 'collectors')
-rw-r--r-- | collectors/debugfs.plugin/multi_metadata.yaml | 162 |
1 files changed, 149 insertions, 13 deletions
diff --git a/collectors/debugfs.plugin/multi_metadata.yaml b/collectors/debugfs.plugin/multi_metadata.yaml index 7cd08ecd56..17ced3561b 100644 --- a/collectors/debugfs.plugin/multi_metadata.yaml +++ b/collectors/debugfs.plugin/multi_metadata.yaml @@ -5,7 +5,7 @@ modules: module_name: /sys/kernel/debug/extfrag monitored_instance: name: System Memory Fragmentation - link: '' + link: 'https://www.kernel.org/doc/html/next/admin-guide/sysctl/vm.html' categories: - data-collection.linux-systems.memory-metrics icon_filename: 'microchip.png' @@ -22,7 +22,7 @@ modules: overview: data_collection: metrics_description: 'Collects memory fragmentation statistics from the Linux kernel' - method_description: '' + method_description: 'Parse data from `debugfs` file' supported_platforms: include: - Linux @@ -46,17 +46,32 @@ modules: description: '' setup: prerequisites: - list: [] + list: + - title: 'filesystem' + description: > + The debugfs filesystem must be mounted on your host for plugin to collect data. + You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. + It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem + before starting netdata. configuration: file: - name: '' - description: '' + name: 'netdata.conf' + section_name: '[plugin:debugfs]' + description: 'This is netdata main configuration file.' options: description: '' folding: - title: '' + title: 'Config options' enabled: true - list: [] + list: + - name: update every + description: Data collection frequency. + default_value: 1 + required: false + - name: command options + description: Additinal parameters for collector + default_value: "" + required: false examples: folding: enabled: true @@ -151,7 +166,7 @@ modules: data_collection: metrics_description: > Collects zswap performance metrics on Linux systems. - method_description: '' + method_description: 'Parse data from `debugfs file.' supported_platforms: include: - Linux @@ -175,17 +190,32 @@ modules: description: '' setup: prerequisites: - list: [] + list: + - title: 'filesystem' + description: > + The debugfs filesystem must be mounted on your host for plugin to collect data. + You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. + It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem + before starting netdata. configuration: file: - name: '' - section_name: '' + name: 'netdata.conf' + section_name: '[plugin:debugfs]' + description: 'This is netdata main configuration file.' options: description: '' folding: - title: '' + title: 'Config options' enabled: true - list: [] + list: + - name: update every + description: Data collection frequency. + default_value: 1 + required: false + - name: command options + description: Additinal parameters for collector + default_value: "" + required: false examples: folding: enabled: true @@ -257,3 +287,109 @@ modules: chart_type: line dimensions: - name: duplicate + - meta: + plugin_name: debugfs.plugin + module_name: intel_rapl + monitored_instance: + name: Power Capping + link: 'https://www.kernel.org/doc/html/next/power/powercap/powercap.html' + categories: + - data-collection.linux-systems.kernel-metrics + icon_filename: 'powersupply.svg' + related_resources: + integrations: + list: [] + info_provided_to_referring_integrations: + description: '' + keywords: + - power capping + - energy + most_popular: false + overview: + data_collection: + metrics_description: > + Collects power capping performance metrics on Linux systems. + method_description: 'Parse data from `debugfs file.' + supported_platforms: + include: + - Linux + exclude: [] + multi_instance: false + additional_permissions: + description: > + This integration requires read access to files under `/sys/devices/virtual/powercap`, which are accessible + only to the root user by default. Netdata uses Linux Capabilities to give the plugin access to + debugfs. `CAP_DAC_READ_SEARCH` is added automatically during installation. This capability allows bypassing + file read permission checks and directory read and execute permission checks. If file capabilities are not + usable, then the plugin is instead installed with the SUID bit set in permissions so that it runs as root. + default_behavior: + auto_detection: + description: > + Assuming that debugfs is mounted and the required permissions are available, this integration will + automatically detect whether or not the system is using zswap. + limits: + description: '' + performance_impact: + description: '' + setup: + prerequisites: + list: + - title: 'filesystem' + description: > + The debugfs filesystem must be mounted on your host for plugin to collect data. + You can run the command-line (`sudo mount -t debugfs none /sys/kernel/debug/`) to mount it locally. + It is also recommended to modify your fstab (5) avoiding necessity to mount the filesystem + before starting netdata. + configuration: + file: + name: 'netdata.conf' + section_name: '[plugin:debugfs]' + description: 'This is netdata main configuration file.' + options: + description: '' + folding: + title: 'Config options' + enabled: true + list: + - name: update every + description: Data collection frequency. + default_value: 1 + required: false + - name: command options + description: Additinal parameters for collector + default_value: "" + required: false + examples: + folding: + enabled: true + title: '' + list: [] + troubleshooting: + problems: + list: [] + alerts: [] + metrics: + folding: + title: Metrics + enabled: false + description: "Monitor the Intel RAPL zones Consumption." + availability: [] + scopes: + - name: global + description: "Global Intel RAPL zones." + labels: [] + metrics: + - name: cpu.powercap_intel_rapl_zone + description: Intel RAPL Zone Power Consumption + unit: "Watts" + chart_type: line + dimensions: + - name: Power + - name: cpu.powercap_intel_rapl_subzones + description: Intel RAPL Subzones Power Consumption + unit: "Watts" + chart_type: line + dimensions: + - name: dram + - name: core + - name: uncore |