Logstash

Agent Check

Overview

Get metrics from Logstash service in real time to:

• Visualize and monitor Logstash states.
• Be notified about Logstash events.

Setup

The Logstash check is NOT included in the Datadog Agent package.

Installation

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

1. Install the developer toolkit.

2. Clone the integrations-extras repository:

   git clone https://github.com/DataDog/integrations-extras.git.

3. Update your ddev config with the integrations-extras/ path:

   ddev config set extras ./integrations-extras

4. To build the logstash package, run:

   ddev -e release build logstash

5. Download and launch the Datadog Agent.

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

   datadog-agent integration install -w <PATH_OF_LOGSTASH_ARTIFACT_>/<LOGSTASH_ARTIFACT_NAME>.whl

7. Configure your integration like any other packaged integration.

Configuration

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

2. Restart the Agent

Metric Collection

Add this configuration setup to your conf.yaml file to start gathering your Logstash metrics:

init_config:

instances:
  # The URL where Logstash provides its monitoring API.
  # This will be used to fetch various runtime metrics about Logstash.
  #
  - url: http://localhost:9600

Configure it to point to your server and port.

See the sample conf.yaml for all available configuration options.

Finally, restart the Agent to begin sending Logstash metrics to Datadog.

Log Collection

Datadog has an output plugin for Logstash that takes care of sending your logs to your Datadog platform.

To install this plugin run the following command:

• logstash-plugin install logstash-output-datadog_logs

Then configure the datadog_logs plugin with your Datadog API key:

output {
    datadog_logs {
        api_key => "<DATADOG_API_KEY>"
    }
}

By default, the plugin is configured to send logs through HTTPS (port 443) using gzip compression. You can change this behavior by using the following parameters:

• use_http: Set this to false if you want to use TCP forwarding and update the host and port accordingly (default is true).
• use_compression: Compression is only available for HTTP. Disable it by setting this to false (default is true).
• compression_level: Set the compression level from HTTP. The range is from 1 to 9, 9 being the best ratio (default is 6).

Additional parameters can be used to change the endpoint used in order to go through a proxy:

• host: The proxy endpoint for logs not directly forwarded to Datadog (default value: http-intake.logs.datadoghq.com).
• port: The proxy port for logs not directly forwarded to Datadog (default value: 80).
• ssl_port: The port used for logs forwarded with a secure TCP/SSL connection to Datadog (default value: 443).
• use_ssl: Instructs the Agent to initialize a secure TCP/SSL connection to Datadog (default value: true).
• no_ssl_validation: Disables SSL hostname validation (default value: false).

This also can be used to send logs to Datadog EU by setting:

output {
   datadog_logs {
       api_key => "<DATADOG_API_KEY>"
       host => "http-intake.logs.datadoghq.eu"
   }
}

Add metadata to your logs

In order to get the best use out of your logs in Datadog, it is important to have the proper metadata associated with your logs, including hostname and source. By default, the hostname and timestamp should be properly remapped thanks to Datadog’s default remapping for reserved attributes. To make sure the service is correctly remapped, add its attribute value to the service remapping list.

Source

Set up a Logstash filter to set the source (Datadog integration name) on your logs.

filter {
  mutate {
    add_field => {
 "ddsource" => "<MY_SOURCE_VALUE>"
       }
    }
 }

This triggers the integration automatic setup in Datadog.

Custom tags

Host tags are automatically set on your logs if there is a matching hostname in your infrastructure list. Use the ddtags attribute to add custom tags to your logs:

filter {
  mutate {
    add_field => {
        "ddtags" => "env:test,<KEY:VALUE>"
       }
    }
 }

Validation

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

Compatibility

The Logstash check is compatible with Logstash 5.x, 6.x and 7.x versions. It also supports the new multi-pipelines metrics introduced in Logstash 6.0. Tested with Logstash versions 5.6.15, 6.3.0 and 7.0.0.

Data Collected

Metrics

Events

The Logstash check does not include any events.

Service checks

logstash.can_connect:

Returns Critical if the Agent cannot connect to Logstash to collect metrics; returns OK otherwise.

Troubleshooting

Agent cannot connect

    logstash
    -------
      - instance #0 [ERROR]: "('Connection aborted.', error(111, 'Connection refused'))"
      - Collected 0 metrics, 0 events & 1 service check

Check that the url in conf.yaml is correct.

If you need further help, contact Datadog support.