Configure modules

You can configure modules in the modules.d directory (recommended), or in the Metricbeat configuration file. Settings for enabled modules in the modules.d directory take precedence over module settings in the Metricbeat configuration file.

Before running Metricbeat with modules enabled, make sure you also set up the environment to use Kibana dashboards. See Quick start: installation and configuration for more information.

The modules.d directory contains default configurations for all the modules available in Metricbeat. To enable or disable specific module configurations under modules.d, run the modules enable or modules disable command. For example:

metricbeat modules enable apache mysql

metricbeat modules enable apache mysql

./metricbeat modules enable apache mysql

metricbeat modules enable apache mysql

./metricbeat modules enable apache mysql

PS > .\metricbeat.exe modules enable apache mysql

Then when you run Metricbeat, it loads the corresponding module configurations specified in the modules.d directory (for example, modules.d/apache.yml and modules.d/mysql.yml).

To see a list of enabled and disabled modules, run:

metricbeat modules list

metricbeat modules list

./metricbeat modules list

metricbeat modules list

./metricbeat modules list

PS > .\metricbeat.exe modules list

To change the default module configurations, modify the .yml files in the modules.d directory.

The following example shows a basic configuration for the Apache module:

- module: apache
  metricsets: ["status"]
  hosts: ["http://127.0.0.1/"]
  period: 10s
  fields:
    dc: west
  tags: ["tag"]
  processors:
  ....

See Configuration combinations for additional configuration examples.

When possible, you should use the config files in the modules.d directory.

However, configuring modules directly in the config file is a practical approach if you have upgraded from a previous version of Metricbeat and don’t want to move your module configs to the modules.d directory. You can continue to configure modules in the metricbeat.yml file, but you won’t be able to use the modules command to enable and disable configurations because the command requires the modules.d layout.

To enable specific modules and metricsets in the metricbeat.yml config file, add entries to the metricbeat.modules list. Each entry in the list begins with a dash (-) and is followed by settings for that module.

The following example shows a configuration where the apache and mysql modules are enabled:

metricbeat.modules:

#---------------------------- Apache Status Module ---------------------------
- module: apache
  metricsets: ["status"]
  period: 1s
  hosts: ["http://127.0.0.1/"]

#---------------------------- MySQL Status Module ----------------------------
- module: mysql
  metricsets: ["status"]
  period: 2s
  hosts: ["root@tcp(127.0.0.1:3306)/"]

In the following example, the Redis host is crawled for stats information every second because this is critical data, but the full list of Apache metricsets is only fetched every 30 seconds because the metrics are less critical.

metricbeat.modules:
- module: redis
  metricsets: ["info"]
  hosts: ["host1"]
  period: 1s
- module: apache
  metricsets: ["info"]
  hosts: ["host1"]
  period: 30s

Every module comes with a default configuration file. Some modules also come with one or more variant configuration files containing common alternative configurations for that module.

When you see the list of enabled and disabled modules, those modules with configuration variants will be shown as <module_name>-<variant_name>. You can enable or disable specific configuration variants of a module by specifying metricbeat modules enable <module_name>-<variant_name> and metricbeat modules disable <module_name>-<variant_name> respectively.

You can specify a module configuration that uses different combinations of metricsets, periods, and hosts.

For a module with multiple metricsets defined, it’s possible to define the module twice and specify a different period to use for each metricset. For the following example, the set1 metricset will be fetched every 10 seconds, while the set2 metricset will be fetched every 2 minutes:

- module: example
  metricsets: ["set1"]
  hosts: ["host1"]
  period: 10s
- module: example
  metricsets: ["set2"]
  hosts: ["host1"]
  period: 2m

You can specify the following options for any Metricbeat module. Some modules require additional configuration settings. See the Modules section for more information.

The name of the module to run. For documentation about each module, see the Modules section.

A list of metricsets to execute. Make sure that you only list metricsets that are available in the module. It is not possible to reference metricsets from other modules. For a list of available metricsets, see Modules.

A Boolean value that specifies whether the module is enabled. If you use the default config file, metricbeat.yml, the System module is enabled (set to enabled: true) by default. If the enabled option is missing from the configuration block, the module is enabled by default.

How often the metricsets are executed. If a system is not reachable, Metricbeat returns an error for each period. This setting is required.

A list of hosts to fetch information from. For some metricsets, such as the System module, this setting is optional.

A dictionary of fields that will be sent with the metricset event. This setting is optional.

A list of tags that will be sent with the metricset event. This setting is optional.

A list of processors to apply to the data generated by the metricset.

See Processors for information about specifying processors in your config.

If present, this formatted string overrides the index for events from this module (for elasticsearch outputs), or sets the raw_index field of the event’s metadata (for other outputs). This string can only refer to the agent name and version and the event timestamp; for access to dynamic fields, use output.elasticsearch.index or a processor.

Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}" might expand to "metricbeat-myindex-2019.12.13".

If this option is set to true, fields with null values will be published in the output document. By default, keep_null is set to false.

A name given by the user to the service the data is collected from. It can be used for example to identify information collected from nodes of different clusters with the same service.type.

Modules and metricsets that define the host as an HTTP URL can use the standard schemes for HTTP (http:// and https://) and the following schemes to connect to local pipes:

The following options are available for modules and metricsets that define the host as an HTTP URL:

The username to use for basic authentication.

The password to use for basic authentication.

Total time limit for an HTTP connection to be completed (Default: 2 seconds).

Total time limit for HTTP requests made by the module (Default: 10 seconds).

Configuration options for SSL parameters like the certificate authority to use for HTTPS-based connections.

See SSL for more information.

A list of headers to use with the HTTP request. For example:

headers:
  Cookie: abcdef=123456
  My-Custom-Header: my-custom-value

If defined, Metricbeat will read the contents of the file once at initialization and then use the value in an HTTP Authorization header.

An optional base path to be used in HTTP URIs. If defined, Metricbeat will insert this value as the first segment in the HTTP URI path.

An optional value to pass common query params in YAML. Instead of setting the query params within hosts values using the syntax ?key=value&key2&value2, you can set it here like this:

query:
  key: value
  key2: value2
  list:
  - 1.1
  - 2.95
  - -15