WARNING: Version 5.1 of Metricbeat has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« System Diskio Metricset System Fsstat Metricset »
Elastic Docs ›Metricbeat Reference [5.1] ›Modules ›System Module

System Filesystem Metricset

edit

System Filesystem Metricset

edit

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

edit

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

edit

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"
}
« System Diskio Metricset System Fsstat Metricset »