Datadog_metrics 输出插件

编辑

Datadog_metrics 输出插件

编辑
  • 插件版本:v3.0.7
  • 发布日期:2024-10-25
  • 变更日志

对于其他版本,请参阅 版本化插件文档

安装

编辑

对于默认情况下未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-output-datadog_metrics 轻松安装。有关更多详细信息,请参阅 使用插件

获取帮助

编辑

如有任何关于插件的问题,请在 Discuss 论坛中发起主题。对于错误或功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请查阅 Elastic 支持矩阵

描述

编辑

此输出允许您根据 Logstash 事件将指标发送到 DataDogHQ。默认的 queue_sizetimeframe 设置较低,以提供近乎实时的警报。如果您不使用 Datadog 进行警报,请考虑提高这些阈值。

Datadog_metrics 输出配置选项

编辑

此插件支持以下配置选项以及稍后描述的 通用选项

设置 输入类型 必填

api_key

密码

api_url

字符串

dd_tags

数组

设备

字符串

主机

字符串

metric_name

字符串

metric_type

字符串,其中之一为 ["gauge", "counter", "%{metric_type}"]

metric_value

<<,>>

queue_size

数字

timeframe

数字

另请参阅 通用选项,以获取所有输出插件支持的选项列表。

 

api_key

编辑
  • 这是必填设置。
  • 值类型为 密码
  • 此设置没有默认值。

您的 DatadogHQ API 密钥。 https://app.datadoghq.com/account/settings#api

api_url

编辑
  • 值类型为 字符串
  • 默认值为 "https://api.datadoghq.com/api/v1/series"

为 Datadog EU 站点用户设置 API 端点

dd_tags

编辑
  • 值类型为 数组
  • 此设置没有默认值。

为该事件设置任何自定义标签,默认为任何 Logstash 标签。

device

编辑
  • 值类型为 字符串
  • 默认值为 "%{metric_device}"

生成指标的设备名称。

host

编辑
  • 值类型为 字符串
  • 默认值为 "%{host}"

生成指标的主机名称。

metric_name

编辑
  • 值类型为 字符串
  • 默认值为 "%{metric_name}"

时间序列的名称。

metric_type

编辑
  • 值可以是以下任何一个:gaugecounter%{metric_type}
  • 默认值为 "%{metric_type}"

指标的类型。

metric_value

编辑
  • 值类型为 字符串
  • 默认值为 "%{metric_value}"

值。

queue_size

编辑
  • 值类型为 数字
  • 默认值为 10

@timeframe 中设置的计划之前,在刷新到 Datadog 之前要排队的事件数量。

timeframe

编辑
  • 值类型为 数字
  • 默认值为 10

刷新排队事件到 Datadog 的频率(以秒为单位)。

通用选项

编辑

所有输出插件都支持这些配置选项。

设置 输入类型 必填

编解码器

编解码器

enable_metric

布尔值

ID

字符串

codec

编辑

用于输出数据的编解码器。输出编解码器是在数据离开输出之前对其进行编码的便捷方法,而无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下,我们会记录所有可以记录的指标,但您可以禁用特定插件的指标收集。

  • 值类型为 字符串
  • 此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID,Logstash 将生成一个。强烈建议在配置中设置此 ID。当您拥有两种或多种相同类型的插件时,这尤其有用。例如,如果您有 2 个 datadog_metrics 输出。在这种情况下,添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  datadog_metrics {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。