timber 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73567629c6afb913426d711c96cb394d9e2bf741
-  data.tar.gz: 952d3e7d73d9de740abdaf536d3eb3fe985024e4
+  metadata.gz: baa611c5defcf24154ffcb829af28252a93b7eda
+  data.tar.gz: 08ecbf18b034d297b1d184c362bb6789b7655df6
 SHA512:
-  metadata.gz: 5ddc053cd804b4121e27fd91128b9f950270a85fc10a316a57f9a618000c46e5fbe07627a492af9574d7c77096004da07b21343263155cf40dc534f1301174d5
-  data.tar.gz: 2f063f0a6ec629265f4fbd1f2d7de23392d81faaef3a671fc02129bdfa984ddbda873391ca118040cda3a27fe61ad599a4920ce9014b05e2da757bbb1375ca61
+  metadata.gz: aec84b46f8264c4ea92413c5c85c3277751691148048bb98a8f13554473301429b783c04c1fe5037e13985f3489042fe682dde07064fb59f5601c6cce8a828b6
+  data.tar.gz: 716a20f56eec22a0447d2a7752b21e5a5de98d887991325ff0a7dad3253ef4cfba89d13ca36f48f9f09153d06d8f37635c0eb18d136739d117fdc745f876cd56

data/README.md

@@ -4,17 +4,15 @@
 [![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)
 
-[Timber.io](https://timber.io) is a simple cloud-based logging platform built for developers.
-This is our official Ruby library.
+[Timber](https://timber.io) is a cloud-based logging system that integrates directly with your
+Ruby app to capture context and metadata without parsing. This produces rich, clean, readable logs
+that are easier to search and use:
 
-## Overview
-
-Ruby logs are broken. They're noisy, unparesable, and in the context of multiple servers and processes, unreadable. Current logging systems built for ops engineers haven't helped. This is why we built Timber. It's a different approach to Ruby logging. Instead of prefixing your logs with noisy tags, Timber integrates directly with your application, capturing rich context and metadata without altering your logs. This makes your logs easy to [search, use, and _read_](#do-amazing-things-with-your-logs), giving you _complete_ insight into your Ruby app.
-
-1. [**Easy setup** - `bundle exec timber install`](#installation)
-2. [**Powerful logging**](#usage)
-3. [**Seamlessly integrates with popular libraries and frameworks**](#integrations)
-4. [**Do amazing things with your Ruby logs**](#do-amazing-things-with-your-logs)
+1. [**Installation** - One command: `bundle exec timber install`](#installation)
+2. [**Usage** - Simple yet powerful API](#usage)
+3. [**Integrations** - Automatic context and metadata for your existing logs](#integrations)
+4. [**The Timber Console** - Designed for Ruby developers](#the-timber-console)
+5. [**Get things done with your logs 💪**](#get-things-done-with-your-logs)
 
 
 ## Installation
@@ -91,7 +89,7 @@ have to maually set these contexts except in special circumstances.
 ### How to use it
 
 ```ruby
-logger.with_context(job: {id: 123}) do
+Timber.with_context(job: {id: 123}) do
   logger.info("Background job execution started")
   # ... code here
   logger.info("Background job execution completed")
@@ -120,7 +118,7 @@ you are unsure how you'll need to use your data in the future.
 Below is a contrived example of timing a background job:
 
 ```ruby
-timer = Timber::Timer.start
+timer = Timber.start_timer
 # ... code to time ...
 logger.info("Processed background job", background_job: {time_ms: timer})
 ```
@@ -162,8 +160,7 @@ option for anyone transitioning from lograge.
 ```ruby
 # config/initializers/timber.rb
 
-config = Timber::Config.instance
-config.logrageify!()
+Timber.config.logrageify!()
 ```
 
 ### How it works
@@ -192,11 +189,10 @@ Internally this is equivalent to:
 ```ruby
 # config/initializers/timber.rb
 
-config = Timber::Config.instance
-config.integrations.action_controller.silence = true
-config.integrations.action_view.silence = true
-config.integrations.active_record.silence = true
-config.integrations.rack.http_events.collapse_into_single_event = true
+Timber.config.integrations.action_controller.silence = true
+Timber.config.integrations.action_view.silence = true
+Timber.config.integrations.active_record.silence = true
+Timber.config.integrations.rack.http_events.collapse_into_single_event = true
 ```
 
 ### Pro-tip: Keep controller call logs (recommended)
@@ -207,10 +203,9 @@ from lograge with the following settings:
 ```ruby
 # config/initializers/timber.rb
 
-config = Timber::Config.instance
-config.integrations.action_view.silence = true
-config.integrations.active_record.silence = true
-config.integrations.rack.http_events.collapse_into_single_event = true
+Timber.config.integrations.action_view.silence = true
+Timber.config.integrations.active_record.silence = true
+Timber.config.integrations.rack.http_events.collapse_into_single_event = true
 ```
 
 This does _not_ silence the controller call log event. This is because Timber captures the
@@ -235,8 +230,7 @@ The following will silence all `[GET] /_health` requests:
 ```ruby
 # config/initializers/timber.rb
 
-config = Timber::Config.instance
-config.integrations.rack.http_events.silence_request = lambda do |rack_env, rack_request|
+Timber.config.integrations.rack.http_events.silence_request = lambda do |rack_env, rack_request|
   rack_request.path == "/_health"
 end
 ```
@@ -264,8 +258,7 @@ you can do so like:
 ```ruby
 # config/initializers/timber.rb
 
-config = Timber::Config.instance
-config.integrations.rack.user_context.custom_user_hash = lambda do |rack_env|
+Timber.config.integrations.rack.user_context.custom_user_hash = lambda do |rack_env|
   user = rack_env['warden'].user
   if user
     {
@@ -324,9 +317,9 @@ support:
 8. ...more coming soon! Make a request by [opening an issue](https://github.com/timberio/timber-ruby/issues/new)
 
 
-## Do amazing things with your logs
+## Get things done with your logs
 
-Unlock the potential of your logs:
+Logging features every developer needs:
 
 1. [**Powerful searching.** - Find what you need faster.](https://timber.io/docs/app/console/searching)
 2. [**Live tail users.** - Easily solve customer issues.](https://timber.io/docs/app/console/tail-a-user)

data/lib/timber.rb

@@ -18,4 +18,19 @@ require "timber/timer"
 require "timber/frameworks"
 
 module Timber
+  # Access the main configuration object. Please see {{Timber::Config}} for more details.
+  def self.config
+    Config.instance
+  end
+
+  # Starts a timer for timing events. Please see {{Timber::Timber.start}} for more details.
+  def self.start_timer
+    Timer.start
+  end
+
+  # Adds context to all logs written within the passed block. Please see
+  # {{Timber::CurrentContext.with}} for a more detailed description with examples.
+  def self.with_context(context, &block)
+    CurrentContext.with(context, &block)
+  end
 end

data/lib/timber/logger.rb

@@ -214,8 +214,7 @@ module Timber
       super
     end
 
-    # Convenience method for adding context. Please see {{Timber::CurrentContext.with}} for
-    # a more detailed description and examples.
+    # @private
     def with_context(context, &block)
       Timber::CurrentContext.with(context, &block)
     end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.1.5"
+  VERSION = "2.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.6
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack