System cpu metricsetedit

The System cpu metricset provides CPU statistics.

This metricset is available on:

  • FreeBSD
  • Linux
  • macOS
  • OpenBSD
  • Windows

Configurationedit

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.

Fieldsedit

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",
    "event": {
        "dataset": "system.cpu",
        "duration": 115000,
        "module": "system"
    },
    "host": {
        "cpu": {
            "usage": 0.1828
        }
    },
    "metricset": {
        "name": "cpu",
        "period": 10000
    },
    "service": {
        "type": "system"
    },
    "system": {
        "cpu": {
            "cores": 12,
            "idle": {
                "norm": {
                    "pct": 0.8172
                },
                "pct": 9.8063,
                "ticks": 2704392356
            },
            "nice": {
                "norm": {
                    "pct": 0
                },
                "pct": 0,
                "ticks": 0
            },
            "system": {
                "norm": {
                    "pct": 0.0543
                },
                "pct": 0.6511,
                "ticks": 147798591
            },
            "total": {
                "norm": {
                    "pct": 0.1828
                },
                "pct": 2.1937
            },
            "user": {
                "norm": {
                    "pct": 0.1285
                },
                "pct": 1.5426,
                "ticks": 123396960
            }
        }
    }
}