Circonus 输出插件编辑

  • 插件版本:v3.0.7
  • 发布日期:2023-05-30
  • 变更日志

有关其他版本,请参阅 版本化插件文档

安装编辑

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

获取帮助编辑

如果您对插件有任何疑问,请在 讨论 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述编辑

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

Circonus 输出配置选项编辑

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

设置 输入类型 必需

annotation

hash

api_token

password

app_name

string

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

 

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

boolean

id

string

codec编辑

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

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

enable_metric编辑

  • 值类型为 boolean
  • 默认值为 true

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

id编辑

  • 值类型为 string
  • 此设置没有默认值。

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

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

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