:modulename: apache mysql

[[configuration-metricbeat]]
== Configure modules

++++
<titleabbrev>Modules</titleabbrev>
++++

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

Before running {beatname_uc} with modules enabled, make sure you also set up the
environment to use {kib} dashboards. See
<<{beatname_lc}-installation-configuration>> for more information.

include::{libbeat-dir}/shared-note-file-permissions.asciidoc[]

[float]
[[configure-modules-d-configs]]
=== Configure modules in the `modules.d` directory

The `modules.d` directory contains default configurations for all the modules
available in {beatname_uc}. To enable or disable specific module configurations
under `modules.d`, run the
<<modules-command,`modules enable` or `modules disable`>> command. For example:

include::{libbeat-dir}/tab-widgets/enable-modules-widget.asciidoc[]

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:

include::{libbeat-dir}/tab-widgets/list-modules-widget.asciidoc[]

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:

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


See <<config-combos>> for additional configuration examples.

[float]
[[configure-modules-config-file]]
=== Configure modules in the +{beatname_lc}.yml+ file

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

However, configuring <<{beatname_lc}-modules,modules>> directly in the config
file is a practical approach if you have upgraded from a previous version
of {beatname_uc} and don't want to move your module configs to the `modules.d`
directory. You can continue to configure modules in the +{beatname_lc}.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 +{beatname_lc}.yml+ config
file, add entries to the +{beatname_lc}.modules+ list. Each entry in the
list begins with a dash (-) and is followed by settings for that module.

TIP: Check the `modules.d` directory to verify that the modules you've
specified in +{beatname_lc}.yml+ are disabled (filename ends with
`.disabled`). If they aren't, disable them now by running
+{beatname_lc} modules disable <modulename>+.

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

[source,yaml]
------------------------------------------------------------------------------
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.

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

[float]
[[config-variants]]
== Configuration variants

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.

[float]
[[config-combos]]
== Configuration combinations

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:

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


[float]
[[module-config-options]]
=== Standard config options

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

[float]
==== `module`

The name of the module to run. For documentation about each module, see the
<<metricbeat-modules>> section.

[float]
==== `metricsets`

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 <<metricbeat-modules>>.

[float]
==== `enabled`

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.

[float]
[[metricset-period]]
==== `period`

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

[float]
==== `hosts`

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

[float]
==== `fields`

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

[float]
==== `tags`

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

[float]
==== `processors`

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

See <<filtering-and-enhancing-data>> for information about specifying
processors in your config.

[float]
==== `index`

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"`.

[float]
==== `keep_null`

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`.

[float]
==== `service.name`

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`.

[float]
[[module-http-config-options]]
=== Standard HTTP config options

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:

* `http+unix://` to connect to UNIX sockets.
* `http+npipe://` to connect to Windows named pipes.

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

[float]
==== `username`

The username to use for basic authentication.

[float]
==== `password`

The password to use for basic authentication.

[float]
==== `connect_timeout`

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

[float]
==== `timeout`

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

[float]
==== `ssl`

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

See <<configuration-ssl>> for more information.

[float]
==== `headers`

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

[source,yaml]
----
headers:
  Cookie: abcdef=123456
  My-Custom-Header: my-custom-value
----

[float]
==== `bearer_token_file`

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

[float]
==== `basepath`

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.

[float]
==== `query`

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:

[source,yaml]
----
query:
  key: value
  key2: value2
  list:
  - 1.1
  - 2.95
  - -15
----
:modulename!:
