Filebeat

Filebeat

Agent Check Agent Check

Linux Mac OS Windows OS Supported

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.

Installation

If you are using Agent v6.8+ follow the instructions below to install the Filebeat check on your host. See the dedicated Agent guide for installing community integrations to install checks with the Agent prior to version 6.8 or the Docker Agent:

  1. Download and launch the Datadog Agent.

  2. Run the following command to install the integrations wheel with the Agent:

    datadog-agent integration install -t datadog-filebeat==<INTEGRATION_VERSION>
    
  3. Configure your integration like any other packaged integration.

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.

Troubleshooting

Need help? Contact Datadog support.