README.md in timber-2.0.4 vs README.md in timber-2.0.5

- old
+ new

@@ -11,14 +11,16 @@ * [Support](mailto:support@timber.io) ## Overview -Timber turns your raw text logs into rich JSON events that can be consumed by the -[Timber.io service](https://timber.io). It improves log data quality at the source, adding -critical `event` and `context` data to your logs so that you can filter out the noise and -solve problems faster. +Timber for Ruby is an optional upgrade you can install for Ruby apps on the +[Timber.io logging platform](https://timber.io). It turns your once raw text logs into +[rich JSON events that contain critical event and context data](https://timber.io/docs/elixir/automatic-schema-and-fields). +These events conform to the [Timber normalized JSON schema](https://timber.io/docs/app/schema-fields) +and dramatically improve the quality of your logs; allowing you to filter out the noise and solve +problems faster. For example, Timber turns this: ``` Sent 200 in 45.ms @@ -28,19 +30,21 @@ ``` 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}}} ``` -Allowing you to run queries in the [Timber console](https://app.timber.io) like: +Allowing you to run extremely powerful queries in the [Timber console](https://timber.io/docs/app/overview/) like: 1. `context.request_id:abcd1234` - View all logs generated for a specific request. 2. `context.user.id:1` - View logs generated by a specific user. 3. `type:http_response` - View specific events (exceptions, sql queries, etc) 4. `http_server_response.time_ms:>=1000` - View slow responses with the ability to zoom out and view them in context (request, user, etc). 5. `level:error` - Levels in your logs! +For a complete overview, see the [Timber for Ruby docs](https://timber.io/docs/ruby/overview/). + ## Installation 1. In `Gemfile`, add the `timber` gem: ```ruby @@ -54,16 +58,17 @@ ## Configuration All configuration options can be seen in the [`Timber::Config docs`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config). +Here are a few popular options: -Here's a few popular options: - 1. `config.timber.format =` - * `:default` - This is the default. It's the original, default, unchanged log messages. - * `:lograge` - Works exactly like [lograge](https://github.com/roidrage/lograge), except Timber's - additional context and metadata is also appended. Lograge++. + + * `:default` - This is the default. It's the original, default, unchanged log messages. + + * `:lograge` - Works exactly like [lograge](https://github.com/roidrage/lograge), except Timber's + additional context and metadata is also appended. Lograge++. ## Usage \ No newline at end of file