Timber 输出插件

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

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

安装

编辑

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

获取帮助

编辑

有关插件的问题,请在Discuss论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个 issue。有关 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

password

keystore_type

字符串

pool_max

数字

proxy

<<,>>

request_timeout

数字

socket_timeout

数字

truststore

有效的文件系统路径

truststore_password

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 字段中的变量替换仅支持环境变量,并且不支持使用来自秘密存储的值。