Timber 输出插件

编辑
  • 插件版本:v1.0.3
  • 发布日期:2017-09-02
  • 变更日志

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

安装

编辑

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

获取帮助

编辑

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

描述

编辑

此输出将结构化事件发送到 Timber.io 日志服务。Timber 是一款专为开发人员设计的基于云的日志服务,提供开箱即用的简易功能,使您能够提高工作效率。您可以 跟踪用户跟踪请求检查 HTTP 参数 以及 搜索 丰富的结构化数据,而不会牺牲可读性。

在内部,它是一种高效的 HTTP 传输,使用批处理和重试来实现快速可靠的交付。

此输出将并行执行最多 pool_max 个请求以提高性能。在为性能调整此插件时请考虑这一点。对于大多数设置,默认值 50 应该足够。

此外,请注意,当使用并行执行时,无法保证事件的严格顺序!

Timber 输出配置选项

编辑

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

设置 输入类型 必需

api_key

您的 Timber.io API 密钥

cacert

有效的 файловая система路径

client_cert

有效的 файловая система路径

client_key

有效的 файловая система路径

connect_timeout

数字

keystore

有效的 файловая система路径

keystore_password

密码

keystore_type

字符串

pool_max

数字

proxy

<<,>>

request_timeout

数字

socket_timeout

数字

truststore

有效的 файловая система路径

truststore_password

密码

truststore_type

字符串

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

 

api_key

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

您的 Timber.io API 密钥。您可以通过在 [Timber 控制台](https://app.timber.io) 中创建应用来获取您的 API。

cacert

编辑
  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义 X.509 CA(.pem 证书),请在此处指定该证书的路径。

client_cert

编辑
  • 值类型为 路径
  • 此设置没有默认值。

如果您想使用客户端证书(请注意,大多数人都不希望这样做),请在此处设置 x509 证书的路径

client_key

编辑
  • 值类型为 路径
  • 此设置没有默认值。

如果您使用客户端证书,请在此处指定加密密钥的路径

connect_timeout

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

等待建立连接的超时时间(以秒为单位)。默认为 10s

keystore

编辑
  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义密钥库(.jks),请在此处指定。这与 .pem 密钥不兼容!

keystore_password

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

在此处指定密钥库密码。请注意,大多数使用 keytool 创建的 .jks 文件都需要密码!

keystore_type

编辑

在此处指定密钥库类型。可以是 JKSPKCS12。默认为 JKS

pool_max

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

最大并发连接数。默认为 50

proxy

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

如果您想使用 HTTP 代理。这支持多种配置语法

  1. 代理主机格式:http://proxy.org:1234
  2. 代理主机格式:{host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
  3. 代理主机格式:{url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}

request_timeout

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

此模块使您可以轻松地向基于 [Manticore](https://github.com/cheald/manticore) 的 Logstash 添加配置完善的 HTTP 客户端。有关其用法的示例,请参阅 https://github.com/logstash-plugins/logstash-input-http_poller 整个请求的超时时间(以秒为单位)

socket_timeout

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

等待套接字上的数据的超时时间(以秒为单位)。默认为 10s

ssl_certificate_validation

编辑

将其设置为 false 以禁用 SSL/TLS 证书验证 注意:将其设置为 false 通常被认为是不安全的!

truststore

编辑
  • 值类型为 路径
  • 此设置没有默认值。

如果您需要使用自定义信任库(.jks),请在此处指定。这与 .pem 证书不兼容!

truststore_password

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

在此处指定信任库密码。请注意,大多数使用 keytool 创建的 .jks 文件都需要密码!

truststore_type

编辑

在此处指定信任库类型。可以是 JKSPKCS12。默认为 JKS

通用选项

编辑

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

设置 输入类型 必需

codec

codec

enable_metric

布尔值

id

字符串

codec

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

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

enable_metric

编辑

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

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

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

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

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