Circonus 输出插件

编辑
  • 插件版本:v3.0.7
  • 发布时间:2023-05-30
  • 变更日志

其他版本,请参见 版本化插件文档

安装

编辑

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

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发帖。如遇错误或有功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述

编辑

此输出根据 Logstash 事件向 Circonus 发送注释。

Circonus 输出配置选项

编辑

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

设置 输入类型 必填

annotation

哈希

api_token

密码

app_name

字符串

另请参见 常用选项,了解所有输出插件支持的选项列表。

 

annotation

编辑
  • 这是必需设置。
  • 值类型为 哈希
  • 默认值为 {}

注释 向 Circonus 注册注释。唯一必需的字段是 titledescriptionstartstop 将设置为事件时间戳。您也可以添加任何其他可选注释值。所有值都将通过 event.sprintf 传递。

示例

  ["title":"Logstash event", "description":"Logstash event for %{host}"]

  ["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"]

api_token

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

您的 Circonus API 令牌

app_name

编辑
  • 这是必需设置。
  • 值类型为 字符串
  • 此设置没有默认值。

您的 Circonus 应用名称 这将通过 event.sprintf 传递,因此此处允许使用变量。

示例:app_name => "%{myappname}"

常用选项

编辑

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

设置 输入类型 必填

codec

codec

enable_metric

布尔值

id

字符串

codec

编辑
  • 值类型为 codec
  • 默认值为 "plain"

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

enable_metric

编辑

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

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

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

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

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