diff options
Diffstat (limited to 'src/collectors/slabinfo.plugin/metadata.yaml')
-rw-r--r-- | src/collectors/slabinfo.plugin/metadata.yaml | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/src/collectors/slabinfo.plugin/metadata.yaml b/src/collectors/slabinfo.plugin/metadata.yaml new file mode 100644 index 000000000..f19778297 --- /dev/null +++ b/src/collectors/slabinfo.plugin/metadata.yaml @@ -0,0 +1,108 @@ +plugin_name: slabinfo.plugin +modules: + - meta: + plugin_name: slabinfo.plugin + module_name: slabinfo.plugin + monitored_instance: + name: Linux kernel SLAB allocator statistics + link: "https://kernel.org/" + categories: + - data-collection.linux-systems.kernel-metrics + icon_filename: 'linuxserver.svg' + related_resources: + integrations: + list: [] + info_provided_to_referring_integrations: + description: "" + keywords: + - linux kernel + - slab + - slub + - slob + - slabinfo + most_popular: false + overview: + data_collection: + metrics_description: > + Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads + in the kernel. + method_description: "The plugin parses `/proc/slabinfo`" + supported_platforms: + include: + - Linux + exclude: [] + multi_instance: false + additional_permissions: + description: > + This integration requires read access to `/proc/slabinfo`, which is accessible only to the root user by + default. Netdata uses Linux Capabilities to give the plugin access to this file. `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 sVko that it runs as root. + default_behavior: + auto_detection: + description: > + Due to the large number of metrics generated by this integration, it is disabled by default and must be + manually enabled inside `/etc/netdata/netdata.conf` + limits: + description: "" + performance_impact: + description: "" + setup: + prerequisites: + list: + - title: Minimum setup + description: "If you installed `netdata` using a package manager, it is also necessary to install the package `netdata-plugin-slabinfo`." + configuration: + file: + name: "netdata.conf" + section_name: "[plugins]" + description: "The main configuration file." + options: + description: "" + folding: + title: "The main configuration file." + enabled: true + list: + - name: Enable plugin + description: As described above plugin is disabled by default, this option is used to enable plugin. + default_value: no + required: true + examples: + folding: + enabled: true + title: "" + list: [] + troubleshooting: + problems: + list: [] + alerts: [] + metrics: + folding: + title: Metrics + enabled: false + description: "SLAB cache utilization metrics for the whole system." + availability: [] + scopes: + - name: global + description: "" + labels: [] + metrics: + - name: mem.slabmemory + description: Memory Usage + unit: "B" + chart_type: line + dimensions: + - name: a dimension per cache + - name: mem.slabfilling + description: Object Filling + unit: "%" + chart_type: line + dimensions: + - name: a dimension per cache + - name: mem.slabwaste + description: Memory waste + unit: "B" + chart_type: line + dimensions: + - name: a dimension per cache |