Loggly 输出插件

编辑
  • 插件版本:v6.0.0
  • 发布日期:2018-07-03
  • 更新日志

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

有 Loggly 账户吗?使用 Logstash 将日志发送到 Loggly!

这在您可以使用 Logstash 解析和结构化日志并将结构化的 JSON 事件发送到 Loggly 上的账户时最有用。

要使用此功能,您需要使用类型为http且启用了json 日志的 Loggly 输入。

Loggly 输出配置选项

编辑

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

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

 

can_retry

编辑

可以重试。将此值设置为 true 可帮助用户在第一次请求失败时发送多次重试尝试

convert_timestamp

编辑

插件在发送之前将 Logstash 的@timestamp字段重命名为timestamp,以便 Loggly 自动识别它。

如果您的事件没有@timestamp字段,或者您的事件已经有一个timestamp字段,则此操作不会执行任何操作。

请注意,实际的 Logstash 事件不会被输出修改。此修改仅发生在发送之前事件的副本上。

host

编辑
  • 值类型为字符串
  • 默认值为"logs-01.loggly.com"

要将日志发送到的主机名。这应该针对 Loggly http 输入服务器,该服务器通常是“logs-01.loggly.com”(Gen2 账户)。请参阅Loggly HTTP 端点文档

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

用于发送的 Loggly http 客户令牌。您可以在“来源设置”下的“客户令牌”中找到您的令牌。

如果您需要从事件中提取 API 密钥,则可以在此处使用%{foo}字段查找。这主要针对希望向客户的 Loggly 账户提供发送客户日志的多租户托管提供商。

max_event_size

编辑
  • 这是一个必需的设置。
  • 值类型为字节
  • 默认值为 1 Mib

Loggly API 支持的最大事件大小为 1 Mib。

仅当 API 限制发生更改并且您需要覆盖插件的行为时,才需要更改此设置。

请参阅Loggly 批量 API 文档

max_payload_size

编辑
  • 这是一个必需的设置。
  • 值类型为字节
  • 默认值为 5 Mib

Loggly API 支持的最大 API 调用负载为 5 Mib。

仅当 API 限制发生更改并且您需要覆盖插件的行为时,才需要更改此设置。

请参阅Loggly 批量 API 文档

proto

编辑

日志操作应该通过 https 而不是纯 http 发送吗

proxy_host

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

代理主机

proxy_password

编辑
  • 值类型为密码
  • 默认值为""

代理密码

proxy_port

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

代理端口

proxy_user

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

代理用户名

retry_count

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

重试次数。如果出现连接速度缓慢的情况,请求可能会超时,在这种情况下,retry_count 有助于多次重试请求。它将尝试提交请求,直到达到 retry_count,然后停止

Loggly 标签可帮助您在 Loggly 仪表板中轻松查找日志。您可以使用"tag:your_tag"在 Loggly 中搜索标签。

如果您需要在事件中指定多个标签,请按照标签文档中所述进行指定。例如,"tag" => "foo,bar,myApp"

您还可以使用"tag" => "%{somefield},%{another_field}"从事件中的somefieldanother_field中获取标签值。如果该字段不存在,则不会创建任何标签。这有助于利用Loggly 来源组

通用选项

编辑

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

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

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

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

enable_metric

编辑

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

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

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

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

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