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

Latest commit

 

History

History
36 lines (25 loc) · 1.47 KB

overview.md

File metadata and controls

36 lines (25 loc) · 1.47 KB
breadcrumbs title
Timber for Ruby
Overview

Timber for Ruby is an optional upgrade you can install for your Ruby apps. Instead of completely replacing your log messages, this library automatically augments your logs with JSON metadata. Essentially turning them into [rich JSON events with context]({% link _docs/ruby/events-and-context.md %}). This preserves the readability of your logs while still dramatically improving the quality of your data. The end result: better logging and faster problem solving.

How it works

This is accomplished by [installing]({% link _docs/ruby/installation.md %}) our Timber Ruby gem into your application.

For example, it turns this familiar raw text log line:

Sent 200 in 45.ms

Into a [http_server_response JSON event]({% link _docs/ruby/events-and-context/http-server-response-event.md %}).

Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "info", "context": {"user": {"id": 1, "name": "Ben Johnson"}, "http": {"method": "GET", "host": "timber.io", "path": "/path", "request_id": "abcd1234"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}

For a complete list of events, see the [events and context section]({% link _docs/ruby/events-and-context.md %}).

Next: [Installation ]({% link _docs/ruby/installation.md %})