WARNING: Version 5.4 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 Network Metricset System Socket Metricset »

› › ›

System Process Metricset

edit

System Process Metricset

edit

The System process metricset provides process statistics. One document is provided for each process.

This metricset is available on:

Darwin
FreeBSD
Linux
Windows

Control Group (cgroup) Metrics

edit

On Linux this metricset will collect metrics from any cgroups that the process is a member of. This feature is enabled by default and can be disabled by adding process.cgroups.enabled: false to the system module configuration.

Process Environment Variables

edit

This metricset can collect the environment variables that were used to start the process. This feature is available on Linux, Darwin, and FreeBSD. No environment variables are collected by default because they could contain sensitive information. You must configure the environment variables that you wish to collect by specifying a list of regular expressions that match the variable name.

metricbeat.modules:
- module: system
  metricsets: ["process"]
  process.env.whitelist:
  - '^PATH$'
  - '^SSH_.*'

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": {
        "host": "localhost",
        "module": "system",
        "name": "process",
        "rtt": 115
    },
    "system": {
        "process": {
            "cmdline": "go test -tags=integration github.com/elastic/beats/metricbeat/module/... -data",
            "cpu": {
                "start_time": "2016-09-06T07:33:04.000Z",
                "total": {
                    "pct": 0
                }
            },
            "fd": {
                "limit": {
                    "hard": 1048576,
                    "soft": 1048576
                },
                "open": 4
            },
            "memory": {
                "rss": {
                    "bytes": 13770752,
                    "pct": 0.0016
                },
                "share": 6594560,
                "size": 232972288
            },
            "name": "go",
            "pgid": 1,
            "pid": 1,
            "ppid": 0,
            "state": "sleeping",
            "username": "root"
        }
    },
    "type": "metricsets"
}

« System Network Metricset System Socket Metricset »