| 1 | plugin_name: slabinfo.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: slabinfo.plugin |
| 5 | module_name: slabinfo.plugin |
| 6 | monitored_instance: |
| 7 | name: Linux kernel SLAB allocator statistics |
| 8 | link: "https://kernel.org/" |
| 9 | categories: |
| 10 | - data-collection.operating-systems |
| 11 | icon_filename: 'linuxserver.svg' |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - linux kernel |
| 19 | - slab |
| 20 | - slub |
| 21 | - slob |
| 22 | - slabinfo |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: > |
| 26 | Collects metrics on kernel SLAB cache utilization to monitor the low-level performance impact of workloads |
| 27 | in the kernel. |
| 28 | method_description: "The plugin parses `/proc/slabinfo`" |
| 29 | supported_platforms: |
| 30 | include: |
| 31 | - Linux |
| 32 | exclude: [] |
| 33 | multi_instance: false |
| 34 | additional_permissions: |
| 35 | description: > |
| 36 | This integration requires read access to `/proc/slabinfo`, which is accessible only to the root user by |
| 37 | default. Netdata uses Linux Capabilities to give the plugin access to this file. `CAP_DAC_READ_SEARCH` |
| 38 | is added automatically during installation. This capability allows bypassing file read permission checks |
| 39 | and directory read and execute permission checks. If file capabilities are not usable, then the plugin is |
| 40 | instead installed with the SUID bit set in permissions sVko that it runs as root. |
| 41 | default_behavior: |
| 42 | auto_detection: |
| 43 | description: > |
| 44 | Due to the large number of metrics generated by this integration, it is disabled by default and must be |
| 45 | manually enabled inside `/etc/netdata/netdata.conf` |
| 46 | limits: |
| 47 | description: "" |
| 48 | performance_impact: |
| 49 | description: "" |
| 50 | setup: |
| 51 | prerequisites: |
| 52 | list: |
| 53 | - title: Minimum setup |
| 54 | description: "If you installed `netdata` using a package manager, it is also necessary to install the package `netdata-plugin-slabinfo`." |
| 55 | configuration: |
| 56 | file: |
| 57 | name: "netdata.conf" |
| 58 | section_name: "[plugins]" |
| 59 | description: "The main configuration file." |
| 60 | options: |
| 61 | description: "" |
| 62 | folding: |
| 63 | title: "The main configuration file." |
| 64 | enabled: true |
| 65 | list: |
| 66 | - name: Enable plugin |
| 67 | description: As described above plugin is disabled by default, this option is used to enable plugin. |
| 68 | default_value: no |
| 69 | required: true |
| 70 | examples: |
| 71 | folding: |
| 72 | enabled: true |
| 73 | title: "" |
| 74 | list: [] |
| 75 | troubleshooting: |
| 76 | problems: |
| 77 | list: [] |
| 78 | alerts: [] |
| 79 | metrics: |
| 80 | folding: |
| 81 | title: Metrics |
| 82 | enabled: false |
| 83 | description: "SLAB cache utilization metrics for the whole system." |
| 84 | availability: [] |
| 85 | scopes: |
| 86 | - name: global |
| 87 | description: "" |
| 88 | labels: [] |
| 89 | metrics: |
| 90 | - name: mem.slabmemory |
| 91 | description: Memory Usage |
| 92 | unit: "B" |
| 93 | chart_type: line |
| 94 | dimensions: |
| 95 | - name: a dimension per cache |
| 96 | - name: mem.slabfilling |
| 97 | description: Object Filling |
| 98 | unit: "%" |
| 99 | chart_type: line |
| 100 | dimensions: |
| 101 | - name: a dimension per cache |
| 102 | - name: mem.slabwaste |
| 103 | description: Memory waste |
| 104 | unit: "B" |
| 105 | chart_type: line |
| 106 | dimensions: |
| 107 | - name: a dimension per cache |