% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Linux module [metricbeat-module-linux]

::::{warning} This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. ::::

:::::{admonition} Prefer to use {{agent}} for this use case? Refer to the Elastic Integrations documentation.

::::{dropdown} Learn more {{agent}} is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of {{beats}} and {{agent}}.

::::

:::::

The Linux module reports on metrics exclusive to the Linux kernel and GNU/Linux OS.

Example configuration [_example_configuration]

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

yaml

metricbeat.modules:
- module: linux
  period: 10s
  metricsets:
    - "pageinfo"
    - "memory"
    # - ksm
    # - conntrack
    # - iostat
    # - pressure
    # - rapl
  enabled: true
  #hostfs: /hostfs
  #rapl.use_msr_safe: false

Metricsets [_metricsets]

The following metricsets are available:

conntrack {applies_to}stack: beta
iostat {applies_to}stack: beta
ksm {applies_to}stack: beta
memory {applies_to}stack: beta
pageinfo {applies_to}stack: beta
pressure {applies_to}stack: beta
rapl {applies_to}stack: beta