WARNING: Version 6.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 memory metricset System process metricset »
Elastic Docs ›Metricbeat Reference [6.1] ›Modules ›System module

System network metricset

edit

System network metricset

edit

The System network metricset provides network IO metrics collected from the operating system. One event is created for each network interface.

This metricset is available on:

  • FreeBSD
  • Linux
  • macOS
  • Windows

Configuration

edit
interfaces
By default metrics are reported from all network interfaces. To select which interfaces metrics are reported from, use the interfaces configuration option. The value must be an array of interface names. For example: 
metricbeat.modules:
- module: system
  metricsets: [network]
  interfaces: [eth0]

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": "2017-10-12T08:05:34.853Z",
    "beat": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "metricset": {
        "module": "system",
        "name": "network",
        "rtt": 115
    },
    "system": {
        "network": {
            "in": {
                "bytes": 34293500,
                "dropped": 0,
                "errors": 0,
                "packets": 303805
            },
            "name": "lo0",
            "out": {
                "bytes": 34293500,
                "dropped": 0,
                "errors": 0,
                "packets": 303805
            }
        }
    }
}
« System memory metricset System process metricset »