Monitoring BTRFS

This article will help you get the Btrfs plugin for sd-agent configured and returning metrics

Installing the btrfs plugin package

Install the btrfs plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-btrfs

Install the btrfs plugin on RHEL/CentOS:

sudo yum install sd-agent-btrfs

Read more about agent plugins.

Configuring the agent to monitor Btrfs

1. Configure /etc/sd-agent/conf.d/btrfs.yaml


- excluded_devices: [] # List of devices to exclude
  • Optional: if you wish to exclude devices, add them to excluded_devices

2. Restart the agent

sudo /etc/init.d/sd-agent restart


sudo systemctl restart sd-agent

Verifying the configuration
Execute info to verify the configuration with the following:

sudo /etc/init.d/sd-agent info 


/usr/share/python/sd-agent/ info

If the agent has been configured correctly you'll see an output such as:

  - instance #0 [OK]
  - Collected * metrics

You can also view the metrics returned with the following command:

sudo -u sd-agent /usr/share/python/sd-agent/ check btrfs

Configuring graphs

Click the name of your server from the Devices list in your Server Density account then go to the Metrics tab. Click the + Graph button on the right then choose the btrfs metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.


Monitored metrics

Metric Values

The free space on a device
byte / None
Type: float

The total amount of space on a device
byte / None
Type: float

The amount of space used on a device as a fraction of the total
fraction / None
Type: float

The used space on a device
byte / None
Type: float

Metrics Conversion

Please refer to the metrics conversion document to map old metrics names to the new metric names.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Monday  —  Friday.

10am  —  6pm UK.

Dedicated Support.