Loggly 输出插件编辑

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

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

安装编辑

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

获取帮助编辑

有关插件的问题,请在 Discuss 论坛中发布主题。对于错误或功能请求,请在 Github 中创建问题。有关 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 端点文档.

key编辑

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

要用于发送的 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,然后停止

tag编辑

Loggly 标签有助于您轻松地在 Loggly 仪表板中找到您的日志。您可以使用 "tag:your_tag" 在 Loggly 中搜索标签。

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

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

通用选项编辑

以下配置选项由所有输出插件支持

设置 输入类型 必需

enable_metric

布尔值

id

字符串

enable_metric编辑

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

id编辑

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

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

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

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