› ›

Circonus 输出插件

编辑

Circonus 输出插件

编辑

插件版本：v3.0.7
发布于：2023-05-30
更新日志

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

安装

编辑

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

获取帮助

编辑

有关插件的问题，请在Discuss论坛中开一个主题。对于错误或功能请求，请在Github中开一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。

描述

编辑

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

Circonus 输出配置选项

编辑

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

设置	输入类型	必需
`annotation`	哈希	是
`api_token`	密码	是
`app_name`	字符串	是

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

`annotation`

编辑

这是一个必需的设置。
值类型为哈希
默认值为{}

注释向 Circonus 注册注释。唯一必需的字段是 title 和 description。start 和 stop 将设置为事件时间戳。您还可以添加任何其他可选的注释值。所有值都将通过 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`

编辑

值类型为编解码器
默认值为"plain"

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

`enable_metric`

编辑

值类型为布尔值
默认值为true

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

`id`

编辑

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

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

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

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

« Boundary 输出插件 Cloudwatch 输出插件 »