Skip to content
🌲 Highly efficient Fluentd plugin that delivers Fluent events to the Timber API
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib/fluent/plugin
spec
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.md
README.md
fluent-plugin-timber.gemspec

README.md

🌲 Fluent::Plugin::Timber, a plugin for Fluentd

Gem Version Build Status Issue Stats Issue Stats

A highly efficient Fluentd plugin that delivers events to the Timber.io logging service. It uses batching, msgpack, and retry logic for highly efficient and reliable delivery of log data.

Timber.io is a different kind of logging service with a focus on modern logging best-practices: easy setup, structured data, fast clean usable interface, 6 months of searchable retention, threshold based alerts, simple graphing, and more. Learn more at https://timber.io.

Installation

gem install fluent-plugin-timber

Usage

In your Fluentd configuration, use @type timber:

<match your_match>
  @type timber
  api_key xxxxxxxxxxxxxxxxxxxxxxxxxxx        # Your Timber API (required)
  hostname "#{Socket.gethostname}"           # Your hostname (required)
  # ip 127.0.0.1                             # IP address (optional)
  buffer_chunk_limit 1m                      # Must be < 5m
  flush_at_shutdown true                     # Only needed with file buffer
</match>

Configuration

  • api_key - This is your Timber API key. You can obtain your key by creating an app in the Timber console. Registration is one click. If you already have an app, you can locate your API in your app's settings. See our API key docs.
  • hostname - This adds hostname as context to your logs, making it easy to filter by hostname in the Timber console.
  • ip - This adds ip as context to your logs, making it easy to filter by IP address in the Timber console.

For advanced configuration options, please see to the buffered output parameters documentation..


Questions? Need help? support@timber.io.

You can’t perform that action at this time.