Timber output pluginedit

  • Plugin version: v1.0.3
  • Released on: 2017-09-02
  • Changelog

Installationedit

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.

Getting Helpedit

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.

Descriptionedit

This output sends structured events to the Timber.io logging service. Timber is a cloud-based logging service designed for developers, providing easy features out of the box that make you more productive. Tail users, trace requests, inspect HTTP parameters, and search on rich structured data without sacrificing readability.

Internally, it’s a highly efficient HTTP transport that uses batching and retries for fast 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 should be sufficient for most setups.

Additionally, note that when parallel execution is used strict ordering of events is not guaranteed!

Timber Output Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input typeRequired

api_key

Your Timber.io API key

No

cacert

a valid filesystem path

No

client_cert

a valid filesystem path

No

client_key

a valid filesystem path

No

connect_timeout

number

No

keystore

a valid filesystem path

No

keystore_password

password

No

keystore_type

string

No

pool_max

number

No

proxy

<<,>>

No

request_timeout

number

No

socket_timeout

number

No

truststore

a valid filesystem path

No

truststore_password

password

No

truststore_type

string

No

Also see Common Options for a list of options supported by all output plugins.

 

api_keyedit

  • Value type is string
  • There is no default value for this setting.

Your Timber.io API key. You can obtain your API by creating an app in the [Timber console](https://app.timber.io).

cacertedit

  • Value type is path
  • There is no default value for this setting.

If you need to use a custom X.509 CA (.pem certs) specify the path to that here.

client_certedit

  • Value type is path
  • There is no default value for this setting.

If you’d like to use a client certificate (note, most people don’t want this) set the path to the x509 cert here

client_keyedit

  • Value type is path
  • There is no default value for this setting.

If you’re using a client certificate specify the path to the encryption key here

connect_timeoutedit

  • Value type is number
  • Default value is 10

Timeout (in seconds) to wait for a connection to be established. Default is 10s

keystoreedit

  • Value type is path
  • There is no default value for this setting.

If you need to use a custom keystore (.jks) specify that here. This does not work with .pem keys!

keystore_passwordedit

  • Value type is password
  • There is no default value for this setting.

Specify the keystore password here. Note, most .jks files created with keytool require a password!

keystore_typeedit

  • Value type is string
  • Default value is "JKS"

Specify the keystore type here. One of JKS or PKCS12. Default is JKS

pool_maxedit

  • Value type is number
  • Default value is 50

Max number of concurrent connections. Defaults to 50

proxyedit

  • Value type is string
  • There is no default value for this setting.

If you’d like to use an HTTP proxy . This supports multiple configuration syntaxes:

  1. Proxy host in form: http://proxy.org:1234
  2. Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
  3. Proxy host in form: {url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}

request_timeoutedit

  • Value type is number
  • Default value is 60

This module makes it easy to add a very fully configured HTTP client to logstash based on [Manticore](https://github.com/cheald/manticore). For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_poller Timeout (in seconds) for the entire request

socket_timeoutedit

  • Value type is number
  • Default value is 10

Timeout (in seconds) to wait for data on the socket. Default is 10s

ssl_certificate_validationedit

  • Value type is boolean
  • Default value is true

Set this to false to disable SSL/TLS certificate validation Note: setting this to false is generally considered insecure!

truststoreedit

  • Value type is path
  • There is no default value for this setting.

If you need to use a custom truststore (.jks) specify that here. This does not work with .pem certs!

truststore_passwordedit

  • Value type is password
  • There is no default value for this setting.

Specify the truststore password here. Note, most .jks files created with keytool require a password!

truststore_typeedit

  • Value type is string
  • Default value is "JKS"

Specify the truststore type here. One of JKS or PKCS12. Default is JKS

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

codecedit

  • Value type is codec
  • Default value is "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.

enable_metricedit

  • Value type is boolean
  • Default value is 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 collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

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 useful when 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"
  }
}