# 🌲 Timber - Great Ruby Logging Made Easy

<p align="center">
  <a href="https://timber.io" target="_blank" align="center">
    <img src="https://res.cloudinary.com/timber/image/upload/v1552328675/banner.jpg" width="900">
  </a>
  <br>
</p>

[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/timberio/timber-ruby)
[![Build Status](https://travis-ci.org/timberio/timber-ruby.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby)
[![Code Climate](https://codeclimate.com/github/timberio/timber-ruby/badges/gpa.svg)](https://codeclimate.com/github/timberio/timber-ruby)

[Timber.io](https://timber.io) is a hosted service for aggregating logs across your entire stack -
[any language](https://docs.timber.io/setup/languages),
[any platform](https://docs.timber.io/setup/platforms),
[any data source](https://docs.timber.io/setup/log_forwarders).

Unlike traditional logging tools, Timber integrates with language runtimes to automatically
capture in-app context, turning your text-based logs into rich structured events.
Timber integrates with Ruby through this library. And Timber's
[rich free-form query tools](https://docs-new.timber.io/usage/live-tailing#query-syntax) and
[real-time tailing](https://docs-new.timber.io/usage/live-tailing), make drilling down into
important stats easier than ever.

---

### Features

* Simple integration. Exposes the same API as the Ruby Logger.
* Performant, light-weight, and thoughtful design.
* Support for structured logging.
* Support for context.
* Automatic context capturing.
* Integrates with popular 3rd party libraries, such as Rails and Rack.

---

### Get Started

* **[Installation](https://docs.timber.io/setup/languages/ruby#installation)**
* **[Configuration](https://docs.timber.io/setup/languages/ruby#configuration)**
* **[Usage](https://docs.timber.io/setup/languages/ruby#usage)**
* **[Guides](https://docs.timber.io/setup/languages/ruby#guides)**
* **[Integrations](https://docs.timber.io/setup/languages/ruby/integrations)**
* **[Performance](https://docs.timber.io/setup/languages/ruby#performance)**

---

<p align="center">
<a href="https://timber.io">Timber</a> &bull;
<a href="https://docs.timber.io">Docs</a> &bull;
<a href="https://timber.io/pricing">Pricing</a> &bull;
<a href="https://timber.io/terms">Security</a> &bull;
<a href="https://timber.io/privacy">Compliance</a>
</p>