For other versions, see theVersioned plugin docs.
For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-timber
. See Working with plugins for more details.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
This output sends structured events to the Timber.io logging service.Timber is a cloud-based logging service designed for developers, providing easy featuresout of the box that make you more productive.Tail users,trace requests,inspect HTTP parameters,and search on rich structured data withoutsacrificing readability.
Internally, it’s a highly efficient HTTP transport that uses batching and retries forfast and reliable delivery.
This output will execute up to pool_max requests in parallel for performance.Consider this when tuning this plugin for performance. The default of 50 shouldbe sufficient for most setups.
Additionally, note that when parallel execution is used strict ordering of events is notguaranteed!
This plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
Your Timber.io API key |
No |
|
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
No |
||
a valid filesystem path |
No |
|
No |
||
No |
||
No |
||
<<,>> |
No |
|
No |
||
No |
||
a valid filesystem path |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by alloutput plugins.
Your Timber.io API key. You can obtain your API by creating an app in the[Timber console](https://app.timber.io).
If you need to use a custom X.509 CA (.pem certs) specify the path to that here.
If you’d like to use a client certificate (note, most people don’t want this) set the path to the x509 cert here
If you’re using a client certificate specify the path to the encryption key here
10
Timeout (in seconds) to wait for a connection to be established. Default is 10s
If you need to use a custom keystore (.jks
) specify that here. This does not work with .pem keys!
Specify the keystore password here.Note, most .jks files created with keytool require a password!
"JKS"
Specify the keystore type here. One of JKS
or PKCS12
. Default is JKS
50
Max number of concurrent connections. Defaults to 50
If you’d like to use an HTTP proxy . This supports multiple configuration syntaxes:
http://proxy.org:1234
{host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
{url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}
60
This module makes it easy to add a very fully configured HTTP client to logstashbased on [Manticore](https://github.com/cheald/manticore).For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_pollerTimeout (in seconds) for the entire request
10
Timeout (in seconds) to wait for data on the socket. Default is 10s
true
Set this to false to disable SSL/TLS certificate validationNote: setting this to false is generally considered insecure!
If you need to use a custom truststore (.jks
) specify that here. This does not work with .pem certs!
Specify the truststore password here.Note, most .jks files created with keytool require a password!
"JKS"
Specify the truststore type here. One of JKS
or PKCS12
. Default is JKS
The following configuration options are supported by all output plugins:
"plain"
The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.
true
Disable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type. For example, if you have 2 timber outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { timber { id => "my_plugin_id" }}