docs/reference/metricbeat/metricbeat-module-logstash.md
% This file is generated! See metricbeat/scripts/mage/docs_collector.go
:::::{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 logstash module collects metrics about {{ls}}.
The logstash module works with {{ls}} 7.3.0 and later.
The logstash module can be used to collect metrics shown in our {{stack-monitor-app}} UI in {{kib}}. To enable this usage, set xpack.enabled: true and remove any metricsets from the module’s configuration. Alternatively, run metricbeat modules disable logstash and metricbeat modules enable logstash-xpack.
::::{note} When this module is used for {{stack}} Monitoring, it sends metrics to the monitoring index instead of the default index typically used by {{metricbeat}}. For more details about the monitoring index, see Configuring indices for monitoring. ::::
The Logstash module supports the standard configuration options that are described in Modules. Here is an example configuration:
metricbeat.modules:
- module: logstash
metricsets: ["node", "node_stats"]
enabled: true
period: 10s
hosts: ["localhost:9600"]
This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.
The following metricsets are available: