Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Commit

Permalink
Update readme with clearer instructions and interface gif (#49)
Browse files Browse the repository at this point in the history 
* Make install more clear

* Move to the top

* Show lines to remove

* Align

* Align

* Align

* Align

* Add interface gif

* Width 100%

* Link to full gif

* Rearrange

* Move to the bottom

* Update readme

* Add separator

* Add choose one

* Add spacer

* Add spacer

* Add spacer

* Update readme

* Reorder

* Update leading sentence

* Fix readme
  • Loading branch information
@binarylogic
binarylogic committed Feb 24, 2017
1 parent 329e182 commit 3b573ed
Showing 1 changed file with 140 additions and 142 deletions.
282 changes: 140 additions & 142 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# 🌲 Timber - Master your Ruby apps with structured logging

<p align="center" style="background: #140f2a;">
<a href="http://github.com/timberio/timber-ruby"><img src="http://files.timber.io/images/ruby-library-readme-header.gif" height="469" /></a>
<a href="http://files.timber.io/images/readme-interface.gif"><img src="http://files.timber.io/images/readme-interface.gif" width="100%" /></a>
</p>

[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
Expand All @@ -10,108 +10,125 @@
[![Code Climate](https://codeclimate.com/github/timberio/timber-ruby/badges/gpa.svg)](https://codeclimate.com/github/timberio/timber-ruby)
[![View docs](https://img.shields.io/badge/docs-viewdocs-blue.svg?style=flat-square "Viewdocs")](http://www.rubydoc.info/github/timberio/timber-ruby)

Still logging raw text? Timber is a complete *structured* logging solution that you can setup in
minutes. It solves logging so you don't have to!

---
To learn more, checkout out [timber.io](https://timber.io).

👉 **Timber is in beta testing, if interested in joining, please email us at
[beta@timber.io](mailto:beta@timber.io)**

---
## Installation

Still logging raw text? Timber is a complete *structured* logging solution that you can setup in
minutes. It goes beyond traditional log management by focusing on data quality and modern
developer standards.
1. *Add* the `timber` gem in `Gemfile`:

High quality logs, [a modern UX-first interface](https://timber.io), simple setup,
zero-maintenance, 6-month retention, and sane prices are just a few of the benefits Timber
offers.
```ruby
# Gemfile

To learn more, checkout out [timber.io](https://timber.io) or the
["why we built Timber"](http://moss-ibex2.cloudvent.net/blog/why-were-building-timber/)
blog post.
gem 'timber'
```

2. *Install* the `Timber::Logger` in `config/environments/production.rb`:

## Overview
```ruby
# config/environments/production.rb

<details><summary><strong>What are the benefits of using Timber?</strong></summary><p>
# config.log_formatter = ::Logger::Formatter.new # <--------------------------- REMOVE ME
# config.logger = ActiveSupport::TaggedLogging.new(logger) # <----------------- REMOVE ME

1. **Data quality.** The usefulness of your logs starts here. This is why we ship libraries that
structure logs from *within* your application; a fundamental difference from parsing. Not only
is it much more stable, but we can include data you couldn't obtain otherwise.
2. **Human readability.** Structuring your logs doesn't mean they have to be unreadable. Timber
*augments* your logs with structured data. Meaning we do not alter the original log message,
we simply attach metadata to it. And our console is specifically designed to give you access
to this data, without compromising readability. 😮
3. **Reliable downstream consumption.** All log events adhere to a
[normalized, shared, schema](https://github.com/timberio/log-event-json-schema) that follows
[semantic versioning](http://semver.org/) and goes through a [standard release process](https://github.com/timberio/log-event-json-schema/releases).
This means you can *rely* on the structure of your logs and interact consistently with them
across apps of any language: queries, graphs, alerts, and other downstream consumers.
4. **Zero risk of code debt or lock-in.** Logging is a standard that has been around since the dawn
of computers. It's built into every language, framework, and library. Timber adheres strictly
to the default `Logger` interface. There are no special APIs, and no need to pepper your app
with Timber specific code. It's just better logging. If you choose to stop using Timber, you
can do so without consequence.
5. **Long term retention.** Timber is designed on modern big-data principles. As a result, we can
offer 6+ months of retention at prices cheaper than alternatives offering <1 month.
This allows you to unlock your logs for purposes beyond debugging.
config.logger = ActiveSupport::TaggedLogging.new(Timber::Logger.new(STDOUT)) # <-- ADD ME
```

---

<details><summary><strong>Prefer to see an example pull request?</strong></summary><p>

Checkout our the [Timber install example pull request](https://github.com/timberio/ruby-rails-example-app/pull/1/files)

---

</p></details>

<details><summary><strong>What specifically does the Timber library do?</strong></summary><p>
<details><summary><strong>Not using Rails?</strong></summary><p>

1. Captures and structures your framework and 3rd party logs. (see next question)
2. Adds useful context to every log line. (see next question)
3. Allows you to easily add tags and timings to log. (see [Usage](#usage))
4. Provides a framework for logging custom structured events. (see [Usage](#usage))
5. Offers transport strategies to [send your logs](#send-your-logs) to the Timber service.
No problem! You can easily install Timber following these steps:

1. *Insert* the Timber probes:

This should be executed *immediately after* you have required your dependencies.

```ruby
Timber::Probes.insert!
```

2. *Add* the Rack middlewares:

This should be included where you build your `Rack` application. Usually `config.ru`:

```ruby
# Most likely config.ru

Timber::RackMiddlewares.middlewares.each do |m|
use m
end
```

2. *Instantiate* the Timber logger:

This should be *globally* available to your application:

```ruby
logger = Timber::Logger.new(STDOUT)
```

---

</p></details>

<details><summary><strong>What events does Timber capture & structure for me?</strong></summary><p>

Out of the box you get everything in the [`Timber::Events`](lib/timber/events) namespace:

1. [Controller Call Event](lib/timber/events/controller_call.rb)
2. [Exception Event](lib/timber/events/exception.rb)
3. [HTTP Client Request Event (net/http outgoing)](lib/timber/events/http_client_request.rb)
4. [HTTP Client Response Event (resposne from net/http outgoing)](lib/timber/events/http_client_response.rb)
5. [HTTP Server Request Event (incoming client request)](lib/timber/events/http_server_request.rb)
6. [HTTP Server Response Event (response to incoming client request)](lib/timber/events/http_server_response.rb)
7. [SQL Query Event](lib/timber/events/sql_query.rb)
8. [Template Render Event](lib/timber/events/template_render.rb)
9. ...more coming soon, [file an issue](https://github.com/timberio/timber-ruby/issues) to request.

We also add context to every log, everything in the [`Timber::Contexts`](lib/timber/contexts)
namespace. Context is structured data representing the current environment when the log line was
written. It is included in every log line. Think of it like join data for your logs:

1. [HTTP Context](lib/timber/contexts/http.rb)
2. [Organization Context](lib/timber/contexts/organization.rb)
3. [Process Context](lib/timber/contexts/process.rb)
4. [Server Context](lib/timber/contexts/server.rb)
5. [Runtime Context](lib/timber/contexts/runtime.rb)
5. [User Context](lib/timber/contexts/user.rb)
6. ...more coming soon, [file an issue](https://github.com/timberio/timber-ruby/issues) to request.



## Send your logs (choose one)

<details><summary><strong>Heroku (log drains)</strong></summary><p>

The recommended strategy for Heroku is to setup a
[log drain](https://devcenter.heroku.com/articles/log-drains). To get your Timber log drain URL:

👉 **[Add your app to Timber](https://app.timber.io)**

---

</p></details>

<details><summary><strong>What about my current log statements?</strong></summary><p>
<details><summary><strong>All other platforms (Network / HTTP)</strong></summary><p>

They'll continue to work as expected. Timber adheres strictly to the default `::Logger` interface
and will never deviate in *any* way.
1. *Specify* the Timber Network logger backend in `config/environments/production.rb`:

In fact, traditional log statements for non-meaningful events, debug statements, etc, are
encouraged. In cases where the data is meaningful, consider [logging a custom event](#usage).
Replace any existing `config.logger =` calls with:

```ruby
# config/environments/production.rb (or staging, etc)

network_log_device = Timber::LogDevices::Network.new(ENV['TIMBER_LOGS_KEY'])
config.logger = Timber::Logger.new(network_log_device) # <-- Use network_log_device instead of STDOUT
```

2. Obtain your Timber API :key: by **[adding your app in Timber](https://app.timber.io)**.

3. Assign your API key to the `TIMBER_LOGS_KEY` environment variable.

</p></details>

<details><summary><strong>Advanced setup (syslog, file tailing agent, etc)</strong></summary><p>

Checkout our [docs](https://timber.io/docs) for a comprehensive list of install instructions.

</p></details>


## Usage

<details><summary><strong>Basic logging</strong></summary><p>
Expand Down Expand Up @@ -287,103 +304,84 @@ value.
</p></details>


## Jibber-Jabber

## Installation

```ruby
# Gemfile
gem 'timber'
```


## Setup

<details><summary><strong>Rails (all versions, including edge)</strong></summary><p>

👉 **Prefer examples?** Checkout our the [Timber install example pull request](https://github.com/timberio/ruby-rails-example-app/pull/1/files)

---

*Replace* any existing `config.logger=` calls in `config/environments/production.rb` with:

```ruby
# config/environments/production.rb
<details><summary><strong>What specifically does the Timber library do?</strong></summary><p>

config.logger = ActiveSupport::TaggedLogging.new(Timber::Logger.new(STDOUT))
```
1. Captures and structures your framework and 3rd party logs. (see next question)
2. Adds useful context to every log line. (see next question)
3. Allows you to easily add tags and timings to log. (see [Usage](#usage))
4. Provides a framework for logging custom structured events. (see [Usage](#usage))
5. Offers transport strategies to [send your logs](#send-your-logs) to the Timber service.

---

</p></details>

<details><summary><strong>Other</strong></summary><p>

1. *Insert* the Timber probes:

This should be executed *immediately after* you have required your dependencies.

```ruby
Timber::Probes.insert!
```

2. *Add* the Rack middlewares:

This should be included where you build your `Rack` application. Usually `config.ru`:

```ruby
# Most likely config.ru

Timber::RackMiddlewares.middlewares.each do |m|
use m
end
```

2. *Instantiate* the Timber logger:
<details><summary><strong>What are the benefits of using Timber?</strong></summary><p>

This should be *globally* available to your application:
1. **Data quality.** The usefulness of your logs starts here. This is why we ship libraries that
structure logs from *within* your application; a fundamental difference from parsing. Not only
is it much more stable, but we can include data you couldn't obtain otherwise.
2. **Human readability.** Structuring your logs doesn't mean they have to be unreadable. Timber
*augments* your logs with structured data. Meaning we do not alter the original log message,
we simply attach metadata to it. And our console is specifically designed to give you access
to this data, without compromising readability. 😮
3. **Reliable downstream consumption.** All log events adhere to a
[normalized, shared, schema](https://github.com/timberio/log-event-json-schema) that follows
[semantic versioning](http://semver.org/) and goes through a [standard release process](https://github.com/timberio/log-event-json-schema/releases).
This means you can *rely* on the structure of your logs and interact consistently with them
across apps of any language: queries, graphs, alerts, and other downstream consumers.
4. **Zero risk of code debt or lock-in.** Logging is a standard that has been around since the dawn
of computers. It's built into every language, framework, and library. Timber adheres strictly
to the default `Logger` interface. There are no special APIs, and no need to pepper your app
with Timber specific code. It's just better logging. If you choose to stop using Timber, you
can do so without consequence.
5. **Long term retention.** Timber is designed on modern big-data principles. As a result, we can
offer 6+ months of retention at prices cheaper than alternatives offering <1 month.
This allows you to unlock your logs for purposes beyond debugging.

```ruby
logger = Timber::Logger.new(STDOUT)
```
---

</p></details>

<details><summary><strong>What events does Timber capture & structure for me?</strong></summary><p>

## Send your logs
Out of the box you get everything in the [`Timber::Events`](lib/timber/events) namespace:

<details><summary><strong>Heroku (log drains)</strong></summary><p>
1. [Controller Call Event](lib/timber/events/controller_call.rb)
2. [Exception Event](lib/timber/events/exception.rb)
3. [HTTP Client Request Event (net/http outgoing)](lib/timber/events/http_client_request.rb)
4. [HTTP Client Response Event (resposne from net/http outgoing)](lib/timber/events/http_client_response.rb)
5. [HTTP Server Request Event (incoming client request)](lib/timber/events/http_server_request.rb)
6. [HTTP Server Response Event (response to incoming client request)](lib/timber/events/http_server_response.rb)
7. [SQL Query Event](lib/timber/events/sql_query.rb)
8. [Template Render Event](lib/timber/events/template_render.rb)
9. ...more coming soon, [file an issue](https://github.com/timberio/timber-ruby/issues) to request.

The recommended strategy for Heroku is to setup a
[log drain](https://devcenter.heroku.com/articles/log-drains). To get your Timber log drain URL:
We also add context to every log, everything in the [`Timber::Contexts`](lib/timber/contexts)
namespace. Context is structured data representing the current environment when the log line was
written. It is included in every log line. Think of it like join data for your logs:

👉 **[Add your app to Timber](https://app.timber.io)**
1. [HTTP Context](lib/timber/contexts/http.rb)
2. [Organization Context](lib/timber/contexts/organization.rb)
3. [Process Context](lib/timber/contexts/process.rb)
4. [Server Context](lib/timber/contexts/server.rb)
5. [Runtime Context](lib/timber/contexts/runtime.rb)
5. [User Context](lib/timber/contexts/user.rb)
6. ...more coming soon, [file an issue](https://github.com/timberio/timber-ruby/issues) to request.

---

</p></details>

<details><summary><strong>All other platforms (Network / HTTP)</strong></summary><p>

1. *Specify* the Timber Network logger backend in `config/environments/production.rb`:

Replace any existing `config.logger =` calls with:

```ruby
# config/environments/production.rb (or staging, etc)

network_log_device = Timber::LogDevices::Network.new(ENV['TIMBER_LOGS_KEY'])
config.logger = Timber::Logger.new(network_log_device) # <-- Use network_log_device instead of STDOUT
```

2. Obtain your Timber API :key: by **[adding your app in Timber](https://app.timber.io)**.

3. Assign your API key to the `TIMBER_LOGS_KEY` environment variable.

</p></details>
<details><summary><strong>What about my current log statements?</strong></summary><p>

<details><summary><strong>Advanced setup (syslog, file tailing agent, etc)</strong></summary><p>
They'll continue to work as expected. Timber adheres strictly to the default `::Logger` interface
and will never deviate in *any* way.

Checkout our [docs](https://timber.io/docs) for a comprehensive list of install instructions.
In fact, traditional log statements for non-meaningful events, debug statements, etc, are
encouraged. In cases where the data is meaningful, consider [logging a custom event](#usage).

</p></details>

Expand Down

0 comments on commit 3b573ed

Please sign in to comment.