:plugin: datadog
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}s-{plugin}"]

=== Datadog output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

This output sends events to DataDogHQ based on Logstash events.

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


[id="plugins-{type}s-{plugin}-options"]
==== Datadog Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-alert_type>> |<<string,string>>, one of `["info", "error", "warning", "success"]`|No
| <<plugins-{type}s-{plugin}-api_key>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-date_happened>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-dd_tags>> |<<array,array>>|No
| <<plugins-{type}s-{plugin}-priority>> |<<string,string>>, one of `["normal", "low"]`|No
| <<plugins-{type}s-{plugin}-source_type_name>> |<<string,string>>, one of `["nagios", "hudson", "jenkins", "user", "my apps", "feed", "chef", "puppet", "git", "bitbucket", "fabric", "capistrano"]`|No
| <<plugins-{type}s-{plugin}-text>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-title>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
output plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-alert_type"]
===== `alert_type` 

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

Alert type

[id="plugins-{type}s-{plugin}-api_key"]
===== `api_key` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Your DatadogHQ API key

[id="plugins-{type}s-{plugin}-date_happened"]
===== `date_happened` 

  * Value type is <<string,string>>
  * There is no default value for this setting.

Date Happened

[id="plugins-{type}s-{plugin}-dd_tags"]
===== `dd_tags` 

  * Value type is <<array,array>>
  * There is no default value for this setting.

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

[id="plugins-{type}s-{plugin}-priority"]
===== `priority` 

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

Priority

[id="plugins-{type}s-{plugin}-source_type_name"]
===== `source_type_name` 

  * 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

[id="plugins-{type}s-{plugin}-text"]
===== `text` 

  * Value type is <<string,string>>
  * Default value is `"%{message}"`

Text

[id="plugins-{type}s-{plugin}-title"]
===== `title` 

  * Value type is <<string,string>>
  * Default value is `"Logstash event for %{host}"`

Title



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]