﻿---
title: Datadog_metrics output plugin v3.0.6
description: Plugin version: v3.0.6, Released on: 2024-08-09, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v3-0-6-plugins-outputs-datadog_metrics
---

# Datadog_metrics output plugin v3.0.6
- Plugin version: v3.0.6
- Released on: 2024-08-09
- [Changelog](https://github.com/logstash-plugins/logstash-output-datadog_metrics/blob/v3.0.6/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-datadog_metrics-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-datadog_metrics). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

This output lets you send metrics to DataDogHQ based on Logstash events. Default `queue_size` and `timeframe` are low in order to provide near realtime alerting. If you do not use Datadog for alerting, consider raising these thresholds.

## Datadog_metrics Output Configuration Options

This plugin supports the following configuration options plus the [Common options](#v3.0.6-plugins-outputs-datadog_metrics-common-options) described later.

| Setting                                                                              | Input type                                                                                                                  | Required |
|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------|
| [`api_key`](#v3.0.6-plugins-outputs-datadog_metrics-api_key)`api_key`                | [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)password                                            | Yes      |
| [`api_url`](#v3.0.6-plugins-outputs-datadog_metrics-api_url)`api_url`                | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                  | No       |
| [`dd_tags`](#v3.0.6-plugins-outputs-datadog_metrics-dd_tags)`dd_tags`                | [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)array                                                     | No       |
| [`device`](#v3.0.6-plugins-outputs-datadog_metrics-device)`device`                   | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                  | No       |
| [`host`](#v3.0.6-plugins-outputs-datadog_metrics-host)`host`                         | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                  | No       |
| [`metric_name`](#v3.0.6-plugins-outputs-datadog_metrics-metric_name)`metric_name`    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                                  | No       |
| [`metric_type`](#v3.0.6-plugins-outputs-datadog_metrics-metric_type)`metric_type`    | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["gauge", "counter", "%{metric_type}"]` | No       |
| [`metric_value`](#v3.0.6-plugins-outputs-datadog_metrics-metric_value)`metric_value` | <<,>>                                                                                                                       | No       |
| [`queue_size`](#v3.0.6-plugins-outputs-datadog_metrics-queue_size)`queue_size`       | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                                  | No       |
| [`timeframe`](#v3.0.6-plugins-outputs-datadog_metrics-timeframe)`timeframe`          | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                                  | No       |

Also see [Common options](#v3.0.6-plugins-outputs-datadog_metrics-common-options) for a list of options supported by all output plugins.

### `api_key`

- This is a required setting.
- Value type is [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)
- There is no default value for this setting.

Your DatadogHQ API key. 

### `api_url`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"https://api.datadoghq.com/api/v1/series"`

Set the api endpoint for Datadog EU Site users

### `dd_tags`

- Value type is [array](/elastic/logstash-docs-md/tree/main/lsr/value-types#array)
- There is no default value for this setting.

Set any custom tags for this event, default are the Logstash tags if any.

### `device`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"%{metric_device}"`

The name of the device that produced the metric.

### `host`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"%{host}"`

The name of the host that produced the metric.

### `metric_name`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"%{metric_name}"`

The name of the time series.

### `metric_type`

- Value can be any of: `gauge`, `counter`, `%{metric_type}`
- Default value is `"%{metric_type}"`

The type of the metric.

### `metric_value`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- Default value is `"%{metric_value}"`

The value.

### `queue_size`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `10`

How many events to queue before flushing to Datadog prior to schedule set in `@timeframe`

### `timeframe`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `10`

How often (in seconds) to flush queued events to Datadog

## Common options

These configuration options are supported by all output plugins:

| Setting                                                                                 | Input type                                                                    | Required |
|-----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#v3.0.6-plugins-outputs-datadog_metrics-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.0.6-plugins-outputs-datadog_metrics-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.0.6-plugins-outputs-datadog_metrics-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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.

### `id`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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_metrics outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
```
output {
  datadog_metrics {
    id => "my_plugin_id"
  }
}
```