timber 2.1.0.rc1 → 2.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3db79522e2f956e63a0d0954deecd94ed23ed105
-  data.tar.gz: 745fcb202414db0fd5db648b906499aadf832665
+  metadata.gz: afb17c6cddef2161cdea1673f0ff79a60e0738d9
+  data.tar.gz: 2ff32da4c3329a55a0c7c8a76c56c165fd2d7459
 SHA512:
-  metadata.gz: fcf7dcefee624791ceac83ed31d016b3429dcc261e51eddb3305f66038f1eb065c73388b6daedee06d0a89fd1ebea068941535b0f76e65967af1a40f9e1c60df
-  data.tar.gz: 4a2549874d1b67f31333665a37043bda838375c6043041221ae744b5e94d0e3669341ce78b3992b47f3b43b588aaced3e4315434bfd8369d710a6627d9433029
+  metadata.gz: f9c7f09df8f61f7c3d97c589a098e5db6bc4d785ca52e01b70d21d382a3c662b7802b7fc05a63b8e83f495b8e0fdef0a878b439a42e3b2edce161e1320d21610
+  data.tar.gz: 565dc4e47de83e6f430828a2d953a9071f1398ce062cfe4ff3375b064ca721bdcd5dea47c70e4492c28c2449ac36591e77e0fe50f63c7efec82193a8def471e3

data/README.md

@@ -1,4 +1,4 @@
-# 🌲 Timber - Automatic Ruby Structured Logging
+# 🌲 Timber - Simple Ruby Structured Logging
 
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
 [![Build Status](https://travis-ci.org/timberio/timber-ruby.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby)
@@ -24,10 +24,10 @@ focusing on logging.
    in a consistent format. See [how it works](#how-it-works) below.
 
 3. **Seamlessly integrates with popular libraries and frameworks.** - Rails, Rack, Devise,
-   Omniauth, etc. [Automatically captures user context, HTTP context, and event data.](#third-party-support)
+   Omniauth, etc. [Automatically captures user context, HTTP context, and event data.](#third-party-integrations)
 
-4. **Pairs with a modern console.** - Designed specifically for this librariy, instantly
-   usable, zero configuration.
+4. **Pairs with a modern console.** - Designed specifically for this librariy, hosted, instantly
+   usable, zero configuration. [Checkout the docs](https://timber.io/docs/app/overview/).
 
 
 ## Installation
@@ -45,7 +45,7 @@ focusing on logging.
 
 ## How it works
 
-Let's start with an example. Timber turns this familiar raw text log line:
+Let's start with an example. Timber turns this:
 
 ```
 Sent 200 in 45.2ms
@@ -54,13 +54,13 @@ Sent 200 in 45.2ms
 Into a rich [`http_server_response` event](https://timber.io/docs/ruby/events-and-context/http-server-response-event/).
 
 ```
-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"}, "system": {"hostname": "1.server.com", "pid": "254354"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}
+Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "info", "context": {"http": {"method": "GET", "path": "/path", "remote_addr": "192.32.23.12", "request_id": "abcd1234"}, "system": {"hostname": "1.server.com", "pid": "254354"}, "user": {"id": 1, "name": "Ben Johnson", "email": "bens@email.com"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}
 ```
 
 Notice that instead of completely replacing your log messages,
-Timber _augments_ your logs with structured metadata. Turning them into
+Timber _augments_ your logs with structured metadata. Turning turns them into
 [rich events with context](https://timber.io/docs/ruby/events-and-context) without sacrificing
-readability.
+readability. And you have [complete control over which data is captured](#configuration).
 
 This is all accomplished by using the
 [Timber::Logger](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Logger):
@@ -77,20 +77,21 @@ Here's a better look at the 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",
+      "remote_addr": "192.32.23.12",
       "request_id": "abcd1234"
     },
     "system": {
       "hostname": "1.server.com",
       "pid": "254354"
-    }
+    },
+    "user": {
+      "id": 1,
+      "name": "Ben Johnson",
+      "email": "bens@email.com"
+    },
   },
   "event": {
     "http_server_response": {
@@ -118,7 +119,7 @@ So what can you do with this data?
 For a complete overview, see the [Timber for Ruby docs](https://timber.io/docs/ruby/overview/).
 
 
-## Third-party support
+## Third-party integrations
 
 1. **Rails**: Structures ([HTTP requests](https://timber.io/docs/ruby/events-and-context/http-server-request-event/), [HTTP respones](https://timber.io/docs/ruby/events-and-context/http-server-response-event/), [controller calls](https://timber.io/docs/ruby/events-and-context/controller-call-event/), [template renders](https://timber.io/docs/ruby/events-and-context/template-render-event/), and [sql queries](https://timber.io/docs/ruby/events-and-context/sql-query-event/)).
 2. **Rack**: Structures [exceptions](https://timber.io/docs/ruby/events-and-context/exception-event/), captures [HTTP context](https://timber.io/docs/ruby/events-and-context/http-context/), captures [user context](https://timber.io/docs/ruby/events-and-context/user-context/), captures [session context](https://timber.io/docs/ruby/events-and-context/session-context/).
@@ -379,14 +380,15 @@ end
 <details><summary><strong>Capture release / deploy context</strong></summary><p>
 
 [Timber::Contexts::Release](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts/Release)
-tracks the current application release and version. If you are on Heroku, simply enable the
-[dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) feature to get this
-automatically. If you are not, simply add the follow environment variables to have the context
-set automatically.
-
-1. `RELEASE_COMMIT` - `2c3a0b24069af49b3de35b8e8c26765c1dba9ff0`
-2. `RELEASE_CREATED_AT` - `2015-04-02T18:00:42Z`
-3. `RELEASE_VERSION` - `v2.3.1`
+tracks the current application release and version. If you're on Heroku, simply enable the
+[dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) feature. If you are not,
+set the following environment variables and this context will be added automatically:
+
+1. `RELEASE_COMMIT` - Ex: `2c3a0b24069af49b3de35b8e8c26765c1dba9ff0`
+2. `RELEASE_CREATED_AT` - Ex: `2015-04-02T18:00:42Z`
+3. `RELEASE_VERSION` - Ex: `v2.3.1`
+
+All variables are optional, but at least one must be present.
 
 ---
 

data/lib/timber/integrations/rack/http_events.rb

@@ -105,7 +105,11 @@ module Timber
           request = Util::Request.new(env)
 
           if silenced?(env, request)
-            Config.instance.logger.silence do
+            if Config.instance.logger.respond_to?(:silence)
+              Config.instance.logger.silence do
+                @app.call(env)
+              end
+            else
               @app.call(env)
             end
 

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.1.0.rc1"
+  VERSION = "2.1.0.rc2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc1
+  version: 2.1.0.rc2
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack