| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/integrations/btrfs.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/proc.plugin/metadata.yaml" |
| 4 | sidebar_label: "BTRFS" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Storage and Filesystems" |
| 7 | keywords: ['btrfs', 'filesystem'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # BTRFS |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/filesystem.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: proc.plugin |
| 18 | Module: /sys/fs/btrfs |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This integration provides usage and error statistics from the BTRFS filesystem. |
| 25 | |
| 26 | |
| 27 | |
| 28 | This collector is supported on all platforms. |
| 29 | |
| 30 | This collector supports collecting metrics from multiple instances of this integration, including remote instances. |
| 31 | |
| 32 | |
| 33 | ### Default Behavior |
| 34 | |
| 35 | #### Auto-Detection |
| 36 | |
| 37 | This integration doesn't support auto-detection. |
| 38 | |
| 39 | #### Limits |
| 40 | |
| 41 | The default configuration for this integration does not impose any limits on data collection. |
| 42 | |
| 43 | #### Performance Impact |
| 44 | |
| 45 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 46 | |
| 47 | ## Setup |
| 48 | |
| 49 | |
| 50 | ### Prerequisites |
| 51 | |
| 52 | No action required. |
| 53 | |
| 54 | ### Configuration |
| 55 | |
| 56 | #### Options |
| 57 | |
| 58 | |
| 59 | |
| 60 | There are no configuration options. |
| 61 | |
| 62 | |
| 63 | |
| 64 | #### via File |
| 65 | |
| 66 | There is no configuration file. |
| 67 | |
| 68 | ##### Examples |
| 69 | There are no configuration examples. |
| 70 | |
| 71 | |
| 72 | |
| 73 | ## Alerts |
| 74 | |
| 75 | |
| 76 | The following alerts are available: |
| 77 | |
| 78 | | Alert name | On metric | Description | |
| 79 | |:------------|:----------|:------------| |
| 80 | | [ btrfs_allocated ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.disk | percentage of allocated BTRFS physical disk space | |
| 81 | | [ btrfs_data ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.data | utilization of BTRFS data space | |
| 82 | | [ btrfs_metadata ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.metadata | utilization of BTRFS metadata space | |
| 83 | | [ btrfs_system ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.system | utilization of BTRFS system space | |
| 84 | | [ btrfs_device_read_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.device_errors | number of encountered BTRFS read errors | |
| 85 | | [ btrfs_device_write_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.device_errors | number of encountered BTRFS write errors | |
| 86 | | [ btrfs_device_flush_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.device_errors | number of encountered BTRFS flush errors | |
| 87 | | [ btrfs_device_corruption_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.device_errors | number of encountered BTRFS corruption errors | |
| 88 | | [ btrfs_device_generation_errors ](https://github.com/netdata/netdata/blob/master/src/health/health.d/btrfs.conf) | btrfs.device_errors | number of encountered BTRFS generation errors | |
| 89 | |
| 90 | |
| 91 | ## Metrics |
| 92 | |
| 93 | Metrics grouped by *scope*. |
| 94 | |
| 95 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 96 | |
| 97 | |
| 98 | |
| 99 | ### Per btrfs filesystem |
| 100 | |
| 101 | |
| 102 | |
| 103 | Labels: |
| 104 | |
| 105 | | Label | Description | |
| 106 | |:-----------|:----------------| |
| 107 | | filesystem_uuid | TBD | |
| 108 | | filesystem_label | TBD | |
| 109 | |
| 110 | Metrics: |
| 111 | |
| 112 | | Metric | Dimensions | Unit | |
| 113 | |:------|:----------|:----| |
| 114 | | btrfs.disk | unallocated, data_free, data_used, meta_free, meta_used, sys_free, sys_used | MiB | |
| 115 | | btrfs.data | free, used | MiB | |
| 116 | | btrfs.metadata | free, used, reserved | MiB | |
| 117 | | btrfs.system | free, used | MiB | |
| 118 | | btrfs.commits | commits | commits | |
| 119 | | btrfs.commits_perc_time | commits | percentage | |
| 120 | | btrfs.commit_timings | last, max | ms | |
| 121 | |
| 122 | ### Per btrfs device |
| 123 | |
| 124 | |
| 125 | |
| 126 | Labels: |
| 127 | |
| 128 | | Label | Description | |
| 129 | |:-----------|:----------------| |
| 130 | | device_id | TBD | |
| 131 | | filesystem_uuid | TBD | |
| 132 | | filesystem_label | TBD | |
| 133 | |
| 134 | Metrics: |
| 135 | |
| 136 | | Metric | Dimensions | Unit | |
| 137 | |:------|:----------|:----| |
| 138 | | btrfs.device_errors | write_errs, read_errs, flush_errs, corruption_errs, generation_errs | errors | |
| 139 | |
| 140 |