System Filesystem Metricset

The System filesystem metricset provides file system statistics. For each file system, one document is provided.

This metricset is available on:

  • Darwin
  • FreeBSD
  • Linux
  • OpenBSD
  • Windows

Filtering

Often there are mounted filesystems that you do not want Metricbeat to report metrics on. A simple strategy to deal with these filesystems is to configure a drop_event filter that matches the mount_point using a regular expression. Below is an example.

metricbeat.modules:
  - module: system
    period: 30s
    metricsets: ["filesystem"]
    filters:
      - drop_event.when.regexp.mount_point: '^/(sys|cgroup|proc|dev|etc|host)($|/)'

Fields

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

{
    "@timestamp": "2016-05-23T08:05:34.853Z",
    "beat": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "metricset": {
        "module": "system",
        "name": "filesystem",
        "rtt": 115
    },
    "system": {
        "filesystem": {
            "available": 38688276480,
            "device_name": "none",
            "files": 3940352,
            "free": 41930997760,
            "free_files": 3276976,
            "mount_point": "/",
            "total": 63371726848,
            "used": {
                "bytes": 21440729088,
                "pct": 0.3383
            }
        }
    },
    "type": "metricsets"
}