logstash-docs-md
Loading

Datadog output plugin v3.0.4

  • Plugin version: v3.0.4
  • Released on: 2017-11-07
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

This output sends events to DataDogHQ based on Logstash events.

Note that since Logstash maintains no state these will be one-shot events

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required
alert_type string, one of ["info", "error", "warning", "success"] No
api_key string Yes
date_happened string No
dd_tags array No
priority string, one of ["normal", "low"] No
source_type_name string, one of ["nagios", "hudson", "jenkins", "user", "my apps", "feed", "chef", "puppet", "git", "bitbucket", "fabric", "capistrano"] No
text string No
title string No

Also see Common options for a list of options supported by all output plugins.

  • Value can be any of: info, error, warning, success
  • There is no default value for this setting.

Alert type

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Your DatadogHQ API key

  • Value type is string
  • There is no default value for this setting.

Date Happened

  • Value type is array
  • There is no default value for this setting.

Tags Set any custom tags for this event Default are the Logstash tags if any

  • Value can be any of: normal, low
  • There is no default value for this setting.

Priority

  • Value can be any of: nagios, hudson, jenkins, user, my apps, feed, chef, puppet, git, bitbucket, fabric, capistrano
  • Default value is "my apps"

Source type name

text

  • Value type is string
  • Default value is "%{{message}}"

Text

  • Value type is string
  • Default value is "Logstash event for %{{host}}"

Title

These configuration options are supported by all output plugins:

Setting Input type Required
codec codec No
enable_metric boolean No
id string No
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 datadog outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  datadog {
    id => "my_plugin_id"
  }
}