| 1 | plugin_name: diskspace.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: diskspace.plugin |
| 5 | module_name: diskspace.plugin |
| 6 | monitored_instance: |
| 7 | name: Disk space |
| 8 | link: "" |
| 9 | categories: |
| 10 | - data-collection.storage |
| 11 | icon_filename: "hard-drive.svg" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: |
| 15 | - plugin_name: ebpf.plugin |
| 16 | module_name: disk |
| 17 | info_provided_to_referring_integrations: |
| 18 | description: "" |
| 19 | keywords: |
| 20 | - disk |
| 21 | - I/O |
| 22 | - space |
| 23 | - inode |
| 24 | overview: |
| 25 | data_collection: |
| 26 | metrics_description: "Monitor Disk space metrics for proficient storage management. Keep track of usage, free space, and error rates to prevent disk space issues." |
| 27 | method_description: "" |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: "The plugin reads data from `/proc/self/mountinfo` and `/proc/diskstats file`." |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "" |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: [] |
| 44 | configuration: |
| 45 | file: |
| 46 | name: "netdata.conf" |
| 47 | section_name: "[plugin:proc:diskspace]" |
| 48 | description: "This is netdata main configuration file" |
| 49 | options: |
| 50 | description: "You can also specify per mount point `[plugin:proc:diskspace:mountpoint]`" |
| 51 | folding: |
| 52 | title: "Config options" |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update every |
| 56 | description: Data collection frequency. |
| 57 | default_value: 1 |
| 58 | required: false |
| 59 | - name: remove charts of unmounted disks |
| 60 | description: Remove chart when a device is unmounted on host. |
| 61 | default_value: yes |
| 62 | required: false |
| 63 | - name: check for new mount points every |
| 64 | description: Parse proc files frequency. |
| 65 | default_value: 15s |
| 66 | required: false |
| 67 | - name: exclude space metrics on paths |
| 68 | description: Do not show metrics (charts) for listed paths. This option accepts netdata simple pattern. |
| 69 | default_value: /proc/* /sys/* /var/run/user/* /run/user/* /snap/* /var/lib/docker/* |
| 70 | required: false |
| 71 | - name: exclude space metrics on filesystems |
| 72 | description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern. |
| 73 | default_value: "*gvfs *gluster* *s3fs *ipfs *davfs2 *httpfs *sshfs *gdfs *moosefs fusectl autofs" |
| 74 | required: false |
| 75 | - name: exclude inode metrics on filesystems |
| 76 | description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern. |
| 77 | default_value: msdosfs msdos vfat overlayfs aufs* *unionfs |
| 78 | required: false |
| 79 | - name: space usage for all disks |
| 80 | description: Define if plugin will show metrics for space usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option. |
| 81 | default_value: auto |
| 82 | required: false |
| 83 | - name: inodes usage for all disks |
| 84 | description: Define if plugin will show metrics for inode usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option. |
| 85 | default_value: auto |
| 86 | required: false |
| 87 | examples: |
| 88 | folding: |
| 89 | enabled: true |
| 90 | title: "" |
| 91 | list: [] |
| 92 | troubleshooting: |
| 93 | problems: |
| 94 | list: [] |
| 95 | alerts: |
| 96 | - name: disk_space_usage |
| 97 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/disks.conf |
| 98 | metric: disk.space |
| 99 | info: disk ${label:mount_point} space utilization |
| 100 | os: "linux freebsd" |
| 101 | - name: disk_inode_usage |
| 102 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/disks.conf |
| 103 | metric: disk.inodes |
| 104 | info: disk ${label:mount_point} inode utilization |
| 105 | os: "linux freebsd" |
| 106 | metrics: |
| 107 | folding: |
| 108 | title: Metrics |
| 109 | enabled: false |
| 110 | description: "" |
| 111 | availability: [] |
| 112 | scopes: |
| 113 | - name: mount point |
| 114 | description: "" |
| 115 | labels: |
| 116 | - name: mount_point |
| 117 | description: Path used to mount a filesystem |
| 118 | - name: filesystem |
| 119 | description: The filesystem used to format a partition. |
| 120 | - name: mount_root |
| 121 | description: Root directory where mount points are present. |
| 122 | metrics: |
| 123 | - name: disk.space |
| 124 | description: Disk Space Usage |
| 125 | unit: "GiB" |
| 126 | chart_type: stacked |
| 127 | dimensions: |
| 128 | - name: avail |
| 129 | - name: used |
| 130 | - name: reserved_for_root |
| 131 | - name: disk.inodes |
| 132 | description: Disk Files (inodes) Usage |
| 133 | unit: "inodes" |
| 134 | chart_type: stacked |
| 135 | dimensions: |
| 136 | - name: avail |
| 137 | - name: used |
| 138 | - name: reserved_for_root |