IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« System core metricset System diskio metricset »
Elastic Docs ›Metricbeat Reference [7.9] ›Modules ›System module

System cpu metricset

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

System cpu metricset

edit

The System cpu metricset provides CPU statistics.

This metricset is available on:

  • FreeBSD
  • Linux
  • macOS
  • OpenBSD
  • Windows

Configuration

edit
cpu.metrics

This option controls what CPU metrics are reported. The value is a list and three metric types are supported - percentages, normalized_percentages, and ticks. The default value is cpu.metrics: [percentages]. 

metricbeat.modules:
- module: system
  metricsets: [cpu]
  cpu.metrics: [percentages, normalized_percentages, ticks]

This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.

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",
    "agent": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "event": {
        "dataset": "system.cpu",
        "duration": 115000,
        "module": "system"
    },
    "metricset": {
        "name": "cpu"
    },
    "service": {
        "type": "system"
    },
    "system": {
        "cpu": {
            "cores": 4,
            "idle": {
                "norm": {
                    "pct": 0.7198
                },
                "pct": 2.8792,
                "ticks": 81308898
            },
            "iowait": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 499109
            },
            "irq": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 0
            },
            "nice": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 172471
            },
            "softirq": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 578041
            },
            "steal": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 0
            },
            "system": {
                "norm": {
                    "pct": 0.0591
                },
                "pct": 0.2365,
                "ticks": 25140781
            },
            "total": {
                "norm": {
                    "pct": 0.2802
                },
                "pct": 1.1208
            },
            "user": {
                "norm": {
                    "pct": 0.2211
                },
                "pct": 0.8843,
                "ticks": 75216920
            }
        }
    }
}
« System core metricset System diskio metricset »