Filebeat

Supported OS Linux Windows Mac OS

Integration version1.3.0

Overview

Get metrics from Filebeat service in real time to:

  • Visualize and monitor Filebeat states.
  • Be notified about Filebeat failovers and events.

Setup

The Filebeat check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Filebeat check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

  1. Run the following command to install the Agent integration:

    datadog-agent integration install -t datadog-filebeat==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

Configuration

  1. Edit the filebeat.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Filebeat metrics. See the sample filebeat.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

Run the Agent’s status subcommand and look for filebeat under the Checks section.

Data Collected

Metrics

filebeat.registry.unprocessed_bytes
(gauge)
Number of bytes not processed by filebeat yet.
Shown as byte

Events

The Filebeat check does not include any events.

Service Checks

filebeat.can_connect
Returns Critical if the Agent cannot connect to Filebeat to collect metrics, returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

PREVIEWING: esther/docs-9478-fix-split-after-example