Datadog output plugin

edit
  • Plugin version: v3.0.6
  • Released on: 2023-05-31
  • Changelog

For other versions, see the Versioned plugin docs.

Installation

edit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-datadog. See Working with plugins for more details.

Getting help

edit

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

edit

This output sends events to DataDogHQ based on Logstash events.

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

Datadog Output Configuration Options

edit

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

password

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.

 

alert_type

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

Alert type

api_key

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

Your DatadogHQ API key

date_happened

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

Date Happened

dd_tags

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

priority

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

Priority

source_type_name

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

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

Text

title

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

Title

Common options

edit

These configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

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

enable_metric

edit
  • 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"
  }
}

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.