1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
#!/usr/bin/python3
#
# Copyright (C) 2016 Hans van Kranenburg <hans@knorrie.org>
#
# This file is part of python-btrfs.
#
# python-btrfs is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# python-btrfs is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with python-btrfs. If not, see <http://www.gnu.org/licenses/>.
import argparse
import btrfs
import os
import sys
STATE_OK = 0
STATE_WARNING = 1
STATE_CRITICAL = 2
STATE_UNKNOWN = 3
state_str_map = {
STATE_OK: 'OK',
STATE_WARNING: 'WARNING',
STATE_CRITICAL: 'CRITICAL',
STATE_UNKNOWN: 'UNKNOWN',
}
def get_args():
parser = argparse.ArgumentParser("Check BTRFS filesystem usage")
parser.add_argument('-awg', '--allocated-warning-gib', type=int, default=0,
help="Exit with WARNING status if less than the specified amount of "
"disk space (in GiB) is unallocated")
parser.add_argument('-acg', '--allocated-critical-gib', type=int, default=0,
help="Exit with CRITICAL status if less than the specified amount of "
"disk space (in GiB) is unallocated")
parser.add_argument('-awp', '--allocated-warning-percent', type=int, default=100,
help="Exit with WARNING status if more than the specified percent of "
"disk space is allocated")
parser.add_argument('-acp', '--allocated-critical-percent', type=int, default=100,
help="Exit with CRITICAL status if more than the specified percent of "
"disk space is allocated")
parser.add_argument('-m', '--mountpoint', required=True,
help="Path to the BTRFS mountpoint")
args = parser.parse_args()
if not os.path.exists(args.mountpoint):
print("BTRFS mountpoint does not exist: {}".format(args.mountpoint))
return STATE_CRITICAL, args
if not os.access(args.mountpoint, os.R_OK):
print("Mountpoint is not accessible: {}".format(args.mountpoint))
return STATE_CRITICAL, args
if args.allocated_warning_gib < 0:
print("Allocated GiB warning threshold must be a positive integer value: {}".format(
args.allocated_warning_gib))
return STATE_CRITICAL, args
if args.allocated_critical_gib < 0:
print("Allocated GiB critical threshold must be a positive integer value: {}".format(
args.allocated_critical_gib))
return STATE_CRITICAL, args
if args.allocated_warning_percent < 0 or args.allocated_warning_percent > 100:
print("Allocated warning percentage must be between 0 and 100: {}".format(
args.allocated_warning_percent))
return STATE_CRITICAL, args
if args.allocated_critical_percent < 0 or args.allocated_critical_percent > 100:
print("Allocated critical percentage must be between 0 and 100: {}".format(
args.allocated_critical_percent))
return STATE_CRITICAL, args
return STATE_OK, args
def check_usage(args, fs):
warning = False
critical = False
msg = []
GiB = btrfs.utils.SZ_1G
bups = btrfs.utils.pretty_size
usage = fs.usage()
mixed_groups = fs.mixed_groups()
if not mixed_groups:
# Keep it a bit simple and only report remaining free space for data
unused_left = usage.free_data
else:
unused_left = usage.free_mixed
# Allocations are always in the physical address space.
# Usage is always in virtual address space.
if usage.allocatable_left < args.allocated_critical_gib * GiB:
msg.append("Critical: Unallocated left: {} (Unused left: {})".format(
bups(usage.allocatable_left), bups(unused_left)))
critical = True
elif usage.allocatable_left < args.allocated_warning_gib * GiB:
msg.append("Warning: Unallocated left: {} (Unused left: {})".format(
bups(usage.allocatable_left), bups(unused_left)))
warning = True
allocated_pct = int(round((usage.allocated * 100) / usage.allocatable))
# Again, be conservative, and only use remaining data space.
used_pct = int(round((usage.virtual_used * 100) /
(usage.virtual_used + usage.free_data)))
if allocated_pct >= args.allocated_critical_percent:
msg.append("Critical: Allocated: {}% (Used: {}%)".format(allocated_pct, used_pct))
critical = True
elif allocated_pct >= args.allocated_warning_percent:
msg.append("Warning: Allocated: {}% (Used: {}%)".format(allocated_pct, used_pct))
warning = True
summary = []
summary.append("Physical size: {}".format(bups(usage.total)))
summary.append("Allocatable: {}".format(bups(usage.allocatable)))
summary.append("Allocated: {} ({}%)".format(bups(usage.allocated), allocated_pct))
summary.append("Unallocatable: {} (Reclaimable: {})".format(
bups(usage.unallocatable_soft), bups(usage.unallocatable_reclaimable)))
summary.append("Virtual used: {} ({}%)".format(bups(usage.virtual_used), used_pct))
if critical:
return STATE_CRITICAL, msg, summary
if warning:
return STATE_WARNING, msg, summary
return STATE_OK, msg, summary
def check_dev_stats(fs):
state = STATE_OK
msg = []
summary = []
devices = list(fs.devices())
for device in devices:
stats = fs.dev_stats(device.devid)
device_msg = ["{}: {}".format(counter, value)
for counter, value in stats.counters.items()
if value != 0]
if len(device_msg) > 0:
msg.append("Device {}: {}".format(device.devid, ", ".join(device_msg)))
state = STATE_CRITICAL
summary.append("{} device(s)".format(len(devices)))
if state != STATE_OK:
return state, msg, summary
return state, msg, summary
def main():
args_state, args = get_args()
if args_state != STATE_OK:
return args_state
with btrfs.FileSystem(args.mountpoint) as fs:
state = STATE_OK
msg = []
summary = []
usage_state, usage_msg, usage_summary = check_usage(args, fs)
state = max(state, usage_state)
msg.extend(usage_msg)
summary.extend(usage_summary)
dev_stats_state, dev_stats_msg, dev_stats_summary = check_dev_stats(fs)
state = max(state, dev_stats_state)
msg.extend(dev_stats_msg)
summary.extend(dev_stats_summary)
if len(msg) > 0:
print("BTRFS {}: ".format(state_str_map[state]), end='')
print(", ".join(msg))
else:
print("BTRFS OK")
print(", ".join(summary))
return state
if __name__ == "__main__":
sys.exit(main())
|