WARNING: Version 5.2 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.

« Redis Keyspace Metricset System Core Metricset »

› ›

System Module

edit

System Module

edit

The System module allows you to monitor your servers. Because the System module always applies to the local server, the hosts config option is not needed.

Module-Specific Configuration Notes

edit

The System module has these additional config options:

processes

When the process metricset is enabled, you can use the processes option to define a list of regexp expressions to filter the processes that are reported. For more complex filtering, you should use the processors configuration option.

The following example config returns metrics for all processes:

metricbeat.modules:
- module: system
  metricsets: ["process"]
  processes: ['.*']

cgroups

When the process metricset is enabled, you can use the boolean cgroups option to enable the experimental cgroup metrics on Linux.

The following example config enables cgroups metrics on Linux.

metricbeat.modules:
- module: system
  metricsets: ["process"]
  cgroups: true

cpu_ticks

When the cpu or core metricset is enabled, you can specify cpu_ticks: true to report CPU ticks in addition to CPU percentages stats. For example:

metricbeat.modules:
- module: system
  metricsets: ["cpu", "core"]
  cpu_ticks: true

It is strongly recommended to not run docker metricsets with a period smaller then 3 seconds. The request to the docker API already takes up to 2s seconds. Otherwise all the requests would timeout and no data is reported.

Dashboard

edit

The System module comes with a predefined dashboard. For example:

Example Configuration

edit

The System module supports the standard configuration options that are described in Modules Configuration. Here is an example configuration:

metricbeat.modules:
- module: system
  metricsets:
    # CPU stats
    - cpu

    # System Load stats
    - load

    # Per CPU core stats
    #- core

    # IO stats
    #- diskio

    # Per filesystem stats
    - filesystem

    # File system summary stats
    - fsstat

    # Memory stats
    - memory

    # Network stats
    - network

    # Per process stats
    - process

    # Sockets (linux only)
    #- socket
  enabled: true
  period: 10s
  processes: ['.*']

Metricsets

edit

The following metricsets are available:

« Redis Keyspace Metricset System Core Metricset »