datadog

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

Synopsis

This is what it might look like in your config file:
output {
  datadog {
    alert_type => ... # string, one of ["info", "error", "warning", "success"] (optional)
    api_key => ... # string (required)
    codec => ... # codec (optional), default: "plain"
    date_happened => ... # string (optional)
    dd_tags => ... # array (optional)
    priority => ... # string, one of ["normal", "low"] (optional)
    source_type_name => ... # string, one of ["nagios", "hudson", "jenkins", "user", "my apps", "feed", "chef", "puppet", "git", "bitbucket", "fabric", "capistrano"] (optional), default: "my apps"
    text => ... # string (optional), default: "%{message}"
    title => ... # string (optional), default: "Logstash event for %{host}"
    workers => ... # number (optional), default: 1
  }
}

Details

alert_type

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

Alert type

api_key (required setting)

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

This output lets you send events (for now. soon metrics) to DataDogHQ based on Logstash events

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

Your DatadogHQ API key

codec

  • 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.

date_happened

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

Date Happened

dd_tags

  • 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

exclude_tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

priority

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

Priority

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

tags DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

text

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

Text

title

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

Title

type DEPRECATED

  • DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
  • Value type is string
  • Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.


This is documentation from lib/logstash/outputs/datadog.rb