Datadog

Send logs to Datadog

The Datadog output plugin allows to ingest your logs into Datadog.

Before you begin, you need a Datadog account, a Datadog API key, and you need to activate Datadog Logs Management.

Configuration Parameters

Key Description Default

Key	Description	Default
Host	Required - The Datadog server where you are sending your logs.	`http-intake.logs.datadoghq.com`
TLS	Required - End-to-end security communications security protocol. Datadog recommends setting this to `on`.	`off`
compress	Recommended - compresses the payload in GZIP format, Datadog supports and recommends setting this to `gzip`.
apikey	Required - Your Datadog API key.
Proxy	Optional - Specify an HTTP Proxy. The expected format of this value is http://host:port. Note that https is not supported yet.
provider	To activate the remapping, specify configuration flag provider with value `ecs`.
json_date_key	Date key name for output.	`timestamp`
include_tag_key	If enabled, a tag is appended to output. The key name is used `tag_key` property.	`false`
tag_key	The key name of tag. If `include_tag_key` is false, This property is ignored.	`tagkey`
dd_service	Recommended - The human readable name for your service generating the logs (e.g. the name of your application or database). If unset, Datadog will look for the service using Service Remapper."
dd_source	Recommended - A human readable name for the underlying technology of your service (e.g. `postgres` or `nginx`). If unset, Datadog will look for the source in the `ddsource` attribute.
dd_tags	Optional - The tags you want to assign to your logs in Datadog. If unset, Datadog will look for the tags in the `ddtags' attribute.
dd_message_key	By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key.

Host

Required - The Datadog server where you are sending your logs.

http-intake.logs.datadoghq.com

TLS

Required - End-to-end security communications security protocol. Datadog recommends setting this to on.

off

compress

Recommended - compresses the payload in GZIP format, Datadog supports and recommends setting this to gzip.

apikey

Required - Your Datadog API key.

Proxy

Optional - Specify an HTTP Proxy. The expected format of this value is http://host:port. Note that https is not supported yet.

provider

To activate the remapping, specify configuration flag provider with value ecs.

json_date_key

Date key name for output.

timestamp

include_tag_key

If enabled, a tag is appended to output. The key name is used tag_key property.

false

tag_key

The key name of tag. If include_tag_key is false, This property is ignored.

tagkey

dd_service

Recommended - The human readable name for your service generating the logs (e.g. the name of your application or database). If unset, Datadog will look for the service using Service Remapper."

dd_source

Recommended - A human readable name for the underlying technology of your service (e.g. postgres or nginx). If unset, Datadog will look for the source in the ddsource attribute.

dd_tags

Optional - The tags you want to assign to your logs in Datadog. If unset, Datadog will look for the tags in the `ddtags' attribute.

dd_message_key

By default, the plugin searches for the key 'log' and remap the value to the key 'message'. If the property is set, the plugin will search the property name key.

Configuration File

Get started quickly with this configuration file:

[OUTPUT]
    Name        datadog
    Match       *
    Host        http-intake.logs.datadoghq.com
    TLS         on
    compress    gzip
    apikey      <my-datadog-api-key>
    dd_service  <my-app-service>
    dd_source   <my-app-source>
    dd_tags     team:logs,foo:bar

Troubleshooting

403 Forbidden

If you get a 403 Forbidden error response, double check that you have a valid Datadog API key and that you have activated Datadog Logs Management.

Last updated 6 months ago