Refactoring: Moved more storage check parameters from unsorted.py to dedicated module...
[check_mk.git] / checkman / df
blobf7b854e76a212181b2ef5a50224829353e631da2
1 title: Used space and inodes in filesystems
2 agents: linux, windows, aix, solaris, openvms, hpux, freebsd, netbsd, openbsd, macosx
3 catalog: os/storage
4 license: GPL
5 distribution: check_mk
6 description:
7  This check measures the usage of filesystems. The usage
8  is checked against a warning and a critical level, which
9  can be specified in numerous ways.
11  Beware: on Linux and UNIX systems the filesystem might reserve a certain
12  amount for root (typical is 5%). This checks considers that reserved space
13  as used. This is consistent with the percentage-column in the output of {df}
14  on most distributions.  So your filesystem might be at 100% in a situation
15  where root still has 5% free space available. On some distributions, {df}
16  seems to use the user allocatable space instead of the total filesystem size
17  as base for the percentage calculation, this might result in differences
18  between the percentage values shown by that {df} version and the value
19  shown in Check_MK. From our point of view, the calculation of Check_MK is
20  more accurate.
22  {Inodes:} if the agent provides a {df} subsection for {inodes}, this check
23  measures the inodes usage. Thresholds default to (10%, 5%) remaining inodes and 
24  can be set/changed in ruleset {filesystems}.
26  {Trends:} This checks supports filesystem {trends}. This means that the {df} check
27  is able to compute the {change} of the used space over the time and can
28  make a forecast into the future. It can estimate the time when
29  the filesystem will be full.
31  In the default configuration the check will compute the trend based on the
32  data of the last 24 hours using a logarithmic average that gives more recent
33  data a higher weight. Also data beyond the 24 hours will to some small degree be
34  reflected in the computation. The advantage of this algorithm is a more
35  precise prediction and a simpler implementation, which does not need any
36  access to any RRDs or similar storage.
38  Please note that when a filesystem is started to be monitored,
39  the trend of the past is unknown and is assumed to be {zero}.
40  It will take at least one trend range of time until the trend
41  approximately reflects the reality.
43  {Grouping:} In some situations you do not want to monitor a single
44  filesystem but a group of filesystems forming a pool.
45  Only the total usage of the pool is of interest. The {df} check supports pools
46  by defining groups. For each group you specify a name and a list
47  of globbing patterns (path patterns containing {*} and {?}). The name
48  is being used as the check item. All filesystems that match one of
49  the patterns are part of the pool.
51  When using inventory you specify the groups with the ruleset
52  {filesystem_groups}. When configuring manual checks, you specify
53  the list of patterns in the check parameter {"patterns"}.
55 item:
56  The mount point of the filesystem (UNIX) or the drive
57  letter in upper case followed by a colon (Windows). For groups
58  the item is the name of the group.
60 inventory:
61  df supports inventory. All filesystem the agent reports
62  will be inventorized except mount points listed in
63  {inventory_df_exclude_mountpoints} and filesystem types
64  listed in {inventory_df_exclude_fs}. The Windows agent
65  only reports fixed disks. The Linux agent reports filesystems
66  that have a size and are not of type smbfs, tmpfs, cifs or nfs.
68  When {filesystem_groups} is defined and a found filesystem
69  is matching one of the patterns of a group, then instead of a
70  service of the single filesystem a check for the group is being
71  created. The check item is the name of that group in that
72  case.