timber 2.1.0.rc2 → 2.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afb17c6cddef2161cdea1673f0ff79a60e0738d9
-  data.tar.gz: 2ff32da4c3329a55a0c7c8a76c56c165fd2d7459
+  metadata.gz: 5f1b00e64f1666ef47d33c347cea42bcc4d7b262
+  data.tar.gz: cbde1d3d51a40c4e08eb3357f8d1fa72beae5d19
 SHA512:
-  metadata.gz: f9c7f09df8f61f7c3d97c589a098e5db6bc4d785ca52e01b70d21d382a3c662b7802b7fc05a63b8e83f495b8e0fdef0a878b439a42e3b2edce161e1320d21610
-  data.tar.gz: 565dc4e47de83e6f430828a2d953a9071f1398ce062cfe4ff3375b064ca721bdcd5dea47c70e4492c28c2449ac36591e77e0fe50f63c7efec82193a8def471e3
+  metadata.gz: 374705c1b1a8f0e0091d92a4ee0186246af3126a8c4e5e5358591deac6a1f2174052347350d42d1c8d1e79548a9a159438e39bdcbc95a2753182d5b52f18b921
+  data.tar.gz: baa0ba4b26cc7157710213635f12750da54ee3bde50e7b1fdac74a06da5ba2b1314c66db5aa258cfd8a170d4299b4f866520ba9a63a31a6ee39f200f95c9331e

data/README.md

@@ -329,7 +329,8 @@ logger.formatter = Timber::Logger::JSONFormatter.new
 Your options are:
 
 1. [`Timber::Logger::AugmentedFormatter`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Logger/AugmentedFormatter) -
-   (default) A human readable format that _appends_ metadata to the original log line.
+   (default) A human readable format that _appends_ metadata to the original log line. The Timber
+   service can parse this data appropriately.
    Ex: `My log message @metadata {"level":"info","dt":"2017-01-01T01:02:23.234321Z"}`
 
 2. [`Timber::Logger::JSONFormatter`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Logger/JSONFormatter) -
@@ -397,7 +398,7 @@ All variables are optional, but at least one must be present.
 
 ## Jibber-Jabber
 
-<details><summary><strong>Which events and context does Timber capture for me?</strong></summary><p>
+<details><summary><strong>Which events and contexts does Timber capture for me?</strong></summary><p>
 
 Out of the box you get everything in the
 [`Timber::Events`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Events) namespace.
@@ -408,13 +409,31 @@ namespace. Context is structured data representing the current environment when
 was written. It is included in every log line. Think of it like join data for your logs. It's
 how Timber is able to accomplished tailing users (`context.user.id:1`).
 
-Lastly, you can checkout the specific integrations in
+Lastly, you can checkout how we capture these events in
 [`Timber::Integrations`](lib/timber/integrations).
 
 ---
 
 </p></details>
 
+<details><summary><strong>Won't this increase the size of my log data?</strong></summary><p>
+
+Yes. In terms of size, it's no different than adding tags to your logs or any other useful
+data. A few things to point out though:
+
+1. Timber generally _reduces_ the amount of logs your app generates by providing options to
+   consolidate request / response logs, template logs, and even silence logs that are not
+   of value to you. (see [configuration](#configuration) for examples).
+2. Your log provider should be compressing your data and charging you accordingly. Log data
+   is notoriously repetitive, and the context Timber generates is repetitive as well.
+   Because of compression we've seen somes apps only incur a 10% increase in data size.
+
+Finally, log what is useful to you. Quality over quantity certainly applies to logging.
+
+---
+
+</p></details>
+
 <details><summary><strong>What about my current log statements?</strong></summary><p>
 
 They'll continue to work as expected. Timber adheres to the default `::Logger` interface.

data/lib/timber/cli/installer.rb

@@ -15,6 +15,14 @@ module Timber
       end
 
       private
+        def get_delivery_strategy(app)
+          if app.heroku?
+            :stdout
+          else
+            :http
+          end
+        end
+
         # Determines the API key storage prference (environment variable or inline)
         def get_api_key_storage_preference
           io.puts ""

data/lib/timber/cli/installers.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "timber/cli/api"
 require "timber/cli/installers/root"
 require "timber/cli/io/messages"
@@ -14,13 +16,41 @@ module Timber
         io.puts ""
 
         if !api_key
-          io.puts IO::Messages.no_api_key_provided
+          app_url = IO::Messages::APP_URL
+
+          io.puts "Hey there! Welcome to Timber. In order to proceed, you'll need an API key."
+          io.puts "You can grab one by registering at #{IO::ANSI.colorize(app_url, :blue)}."
+          io.puts ""
+          io.puts "It takes less than a minute, with one click Google and Github registration."
+          io.puts ""
 
-          case io.ask_yes_no("Open the Timber app in your brower now?")
-          when :yes
-            OSHelper.open(IO::Messages::APP_URL)
+          if OSHelper.can_open?
+            case io.ask_yes_no("Open #{app_url}?")
+            when :yes
+              puts ""
+              io.task("Opening #{app_url}") do
+                OSHelper.open(app_url)
+              end
+            when :no
+              io.puts ""
+              io.puts "No problem, navigate to the following URL:"
+              io.puts ""
+              io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
+            end
+          else
+            io.puts ""
+            io.puts "Please navigate to:"
+            io.puts ""
+            io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
           end
 
+          io.puts ""
+          io.puts "Once you obtain your API key, you can run the installer like"
+          io.puts ""
+          io.puts "    #{IO::ANSI.colorize("bundle exec timber my-api-key", :blue)}"
+          io.puts ""
+          io.puts "See you soon! 🎈"
+          io.puts ""
         else
           api = API.new(api_key)
           api.event(:started)

data/lib/timber/cli/installers/other.rb

@@ -6,40 +6,47 @@ module Timber
     module Installers
       class Other < Installer
         def run(app)
-          puts ""
-          puts IO::Messages.separator
-          puts ""
-
           if app.heroku?
             install_stdout
           else
             api_key_storage_preference = get_api_key_storage_preference
-            api_key_code = get_api_key_code(api_key_storage_type)
-
+            api_key_code = get_api_key_code(api_key_storage_preference)
             install_http(api_key_code)
           end
+
+          io.puts ""
+          io.puts IO::Messages.separator
+          io.puts ""
+          io.puts "We're going to send a few test messages to ensure communication is working."
+          io.puts ""
+          io.ask_to_proceed
+          io.puts ""
         end
 
         private
           def install_stdout
-            puts ""
-            puts IO::Messages.separator
-            puts ""
-            puts "To integrate Timber, we need to instantiate the logger. Your global"
-            puts "logger should be set to something like this:"
-            puts ""
-            puts colorize("    LOGGER = Timber::Logger.new(STDOUT)", :blue)
+            io.puts ""
+            io.puts IO::Messages.separator
+            io.puts ""
+            io.puts "To integrate Timber, simply use the Timber::Logger. Just set your"
+            io.puts "global logger to something like this:"
+            io.puts ""
+            io.puts IO::ANSI.colorize("    LOGGER = Timber::Logger.new(STDOUT)", :blue)
+            io.puts ""
+            io.ask_to_proceed
           end
 
           def install_http(api_key_code)
-            puts ""
-            puts IO::Messages.separator
-            puts ""
-            puts "To integrate Timber, we need to instantiate the logger. Your global"
-            puts "logger should be set to something like this:"
-            puts ""
-            puts colorize("    log_device = Timber::LogDevices::HTTP.new(#{api_key_code})", :blue)
-            puts colorize("    LOGGER = Timber::Logger.new(log_device)", :blue)
+            io.puts ""
+            io.puts IO::Messages.separator
+            io.puts ""
+            io.puts "To integrate Timber, simply use the Timber::Logger. Just set your"
+            io.puts "global logger to something like this:"
+            io.puts ""
+            io.puts IO::ANSI.colorize("    log_device = Timber::LogDevices::HTTP.new(#{api_key_code})", :blue)
+            io.puts IO::ANSI.colorize("    LOGGER = Timber::Logger.new(log_device)", :blue)
+            io.puts ""
+            io.ask_to_proceed
           end
       end
     end

data/lib/timber/cli/installers/rails.rb

@@ -17,7 +17,13 @@ module Timber
           # Ask all of the questions up front. This allows us to to apply the
           # changes as a neat task list when done.
           development_preference = get_development_preference
-          api_key_storage_preference = get_api_key_storage_preference
+
+          api_key_storage_preference = if get_delivery_strategy(app) == :http
+            get_api_key_storage_preference
+          else
+            nil
+          end
+
           should_logrageify = logrageify?
 
           io.puts ""
@@ -135,11 +141,11 @@ module Timber
             case development_preference
             when :send
               extra_comment = <<-NOTE
-# Note: When you are done testing, simply instantiate the logger like this:
-#
-#   logger = Timber::Logger.new(STDOUT)
-#
-# Be sure to remove the "log_device =" and "logger =" lines below.
+  # Note: When you are done testing, simply instantiate the logger like this:
+  #
+  #   logger = Timber::Logger.new(STDOUT)
+  #
+  # Be sure to remove the "log_device =" and "logger =" lines below.
 NOTE
               extra_comment = extra_comment.rstrip
               install_http(environment_file_path, :inline, extra_comment: extra_comment)
@@ -166,10 +172,11 @@ NOTE
               return true
             end
 
-            if app.heroku?
-              install_stdout(environment_file_path)
-            else
+            case get_delivery_strategy(app)
+            when :http
               install_http(environment_file_path, api_key_storage_preference)
+            when :stdout
+              install_stdout(environment_file_path)
             end
           end
 

data/lib/timber/cli/os_helper.rb

@@ -1,7 +1,7 @@
 module Timber
   class CLI
     module OSHelper
-      def self.copy_to_clipboard?
+      def self.can_copy_to_clipboard?
         `which pbcopy` != ""
       rescue Exception
         false
@@ -34,20 +34,33 @@ module Timber
         end
       end
 
+      def self.can_open?
+        begin
+          `which #{open_command}` != ""
+        rescue Exception
+          false
+        end
+      end
+
       # Attemps to open a URL in the user's default browser across
       # the popular operating systems.
       def self.open(link)
-        if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-          system "start #{link}"
-        elsif RbConfig::CONFIG['host_os'] =~ /darwin/
-          system "open #{link}"
-        elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
-          system "xdg-open #{link}"
-        end
+        `#{open_command} #{link}`
         true
       rescue Exception
         false
       end
+
+      private
+        def self.open_command
+          if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+            "start"
+          elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+            "open"
+          elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
+            "xdg-open"
+          end
+        end
     end
   end
 end

data/lib/timber/config.rb

@@ -25,8 +25,10 @@ module Timber
       end
     end
 
+    DEVELOPMENT_NAME = "development".freeze
     PRODUCTION_NAME = "production".freeze
     STAGING_NAME = "staging".freeze
+    TEST_NAME = "test".freeze
 
     include Singleton
 
@@ -37,10 +39,22 @@ module Timber
       @http_body_limit = 2000
     end
 
+    # Convenience method for logging debug statements to the debug logger
+    # set in this class.
+    # @private
+    def debug(&block)
+      debug_logger = Config.instance.debug_logger
+      if debug_logger
+        message = yield
+        debug_logger.debug(message)
+      end
+      true
+    end
+
     # This is useful for debugging. This Sets a debug_logger to view internal Timber library
     # log messages. The default is `nil`. Meaning log to nothing.
     #
-    # See {#debug_to_file} and {#debug_to_stdout} for convenience methods that handle creating
+    # See {#debug_to_file!} and {#debug_to_stdout!} for convenience methods that handle creating
     # and setting the logger.
     #
     # @example Rails
@@ -59,10 +73,10 @@ module Timber
     # A convenience method for writing internal Timber debug messages to a file.
     #
     # @example Rails
-    #   config.timber.debug_to_file("#{Rails.root}/log/timber.log")
+    #   config.timber.debug_to_file!("#{Rails.root}/log/timber.log")
     # @example Everything else
-    #   Timber::Config.instance.debug_to_file("log/timber.log")
-    def debug_to_file(file_path)
+    #   Timber::Config.instance.debug_to_file!("log/timber.log")
+    def debug_to_file!(file_path)
       unless File.exist? File.dirname path
         FileUtils.mkdir_p File.dirname path
       end
@@ -77,10 +91,10 @@ module Timber
     # A convenience method for writing internal Timber debug messages to STDOUT.
     #
     # @example Rails
-    #   config.timber.debug_to_stdout
+    #   config.timber.debug_to_stdout!
     # @example Everything else
-    #   Timber::Config.instance.debug_to_stdout
-    def debug_to_stdout
+    #   Timber::Config.instance.debug_to_stdout!
+    def debug_to_stdout!
       stdout_logger = ::Logger.new(STDOUT)
       stdout_logger.formatter = SimpleLogFormatter.new
       self.debug_logger = stdout_logger
@@ -203,6 +217,16 @@ module Timber
       end
     end
 
+    # @private
+    def development?
+      environment == DEVELOPMENT_NAME
+    end
+
+    # @private
+    def test?
+      environment == TEST_NAME
+    end
+
     # @private
     def production?
       environment == PRODUCTION_NAME

data/lib/timber/contexts/release.rb

@@ -1,3 +1,4 @@
+require "timber/config"
 require "timber/context"
 require "timber/util"
 
@@ -22,8 +23,10 @@ module Timber
           version = ENV['RELEASE_VERSION'] || ENV['HEROKU_RELEASE_VERSION']
 
           if commit_hash || created_at || version
+            Timber::Config.instance.debug { "Release env vars detected, adding to context" }
             new(commit_hash: commit_hash, created_at: created_at, version: version)
           else
+            Timber::Config.instance.debug { "Release env vars _not_ detected" }
             nil
           end
         end

data/lib/timber/current_context.rb

@@ -1,5 +1,4 @@
-require "singleton"
-
+require "timber/config"
 require "timber/contexts/release"
 
 module Timber
@@ -10,11 +9,15 @@ module Timber
   # @note Because context is appended to every log line, it is recommended that you limit this
   #   to only neccessary data needed to relate your log lines.
   class CurrentContext
-    include Singleton
-
     THREAD_NAMESPACE = :_timber_current_context.freeze
 
     class << self
+      # Impelements the Singleton pattern in a thread specific way. Each thread receives
+      # its own context.
+      def instance
+        Thread.current[THREAD_NAMESPACE] ||= new
+      end
+
       # Convenience method for {CurrentContext#with}. See {CurrentContext#with} for more info.
       def with(*args, &block)
         instance.with(*args, &block)
@@ -41,17 +44,6 @@ module Timber
       end
     end
 
-    # Instantiates a new object, automatically adding context based on env variables (if present).
-    # For example, the {Contexts::ReleaseContext} is automatically added if the proper environment
-    # variables are present. Please see that class for more details.
-    def initialize
-      super
-      release_context = Contexts::Release.from_env
-      if release_context
-        add(release_context)
-      end
-    end
-
     # Adds a context and then removes it when the block is finished executing.
     #
     # @note Because context is included with every log line, it is recommended that you limit this
@@ -89,16 +81,7 @@ module Timber
     #   to only neccessary data.
     def add(*objects)
       objects.each do |object|
-        context = Contexts.build(object) # Normalizes objects into a Timber::Context descendant.
-        key = context.keyspace
-        json = context.as_json # Convert to json now so that we aren't doing it for every line
-        if key == :custom
-          # Custom contexts are merged into the space
-          hash[key] ||= {}
-          hash[key].merge!(json)
-        else
-          hash[key] = json
-        end
+        add_to(hash, object)
       end
       expire_cache!
       self
@@ -151,7 +134,33 @@ module Timber
     private
       # The internal hash that is maintained. Use {#with} and {#add} for hash maintenance.
       def hash
-        Thread.current[THREAD_NAMESPACE] ||= {}
+        @hash ||= build_initial_hash
+      end
+
+      # Builds the initial hash. This is extract into a method to support a threaded
+      # environment. Each thread holds it's own context and also needs to instantiate
+      # it's hash properly.
+      def build_initial_hash
+        new_hash = {}
+        release_context = Contexts::Release.from_env
+        if release_context
+          add_to(new_hash, release_context)
+        end
+        new_hash
+      end
+
+      def add_to(hash, object)
+        context = Contexts.build(object) # Normalizes objects into a Timber::Context descendant.
+        key = context.keyspace
+        json = context.as_json # Convert to json now so that we aren't doing it for every line
+        if key == :custom
+          # Custom contexts are merged into the space
+          hash[key] ||= {}
+          hash[key].merge!(json)
+        else
+          hash[key] = json
+        end
+        hash
       end
 
       # Hook to clear any caching implement in this class

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

@@ -1,9 +1,15 @@
 begin
+  # Rails 3.2 requires you to require all of Rails before requiring
+  # the exception wrapper.
+  require "rails"
   require "action_dispatch/middleware/exception_wrapper"
 rescue Exception
 end
 
+require "timber/config"
+require "timber/events/exception"
 require "timber/integrations/rack/middleware"
+require "timber/util"
 
 module Timber
   module Integrations

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

@@ -1,4 +1,7 @@
+require "timber/contexts/http"
+require "timber/current_context"
 require "timber/integrations/rack/middleware"
+require "timber/util"
 
 module Timber
   module Integrations

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

@@ -1,5 +1,10 @@
 require "set"
 
+require "timber/config"
+require "timber/contexts/http"
+require "timber/current_context"
+require "timber/events/http_server_request"
+require "timber/events/http_server_response"
 require "timber/integrations/rack/middleware"
 
 module Timber

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

@@ -1,3 +1,10 @@
+begin
+  require "rails"
+rescue Exception
+end
+
+require "timber/config"
+require "timber/contexts/session"
 require "timber/integrations/rack/middleware"
 
 module Timber
@@ -9,7 +16,7 @@ module Timber
         def call(env)
           id = get_session_id(env)
           if id
-            context = Contexts::Session.new(id: get_session_id(env))
+            context = Contexts::Session.new(id: id)
             CurrentContext.with(context) do
               @app.call(env)
             end
@@ -20,15 +27,37 @@ module Timber
 
         private
           def get_session_id(env)
-            if env['rack.session']
-              begin
-                env['rack.session'].id
-              rescue Exception
+            if defined?(::Rails)
+              session_key = ::Rails.application.config.session_options[:key]
+              request = ::ActionDispatch::Request.new(env)
+              Timber::Config.instance.debug { "Rails detected, extracting session_id from cookie" }
+              extract_from_cookie(request, session_key)
+
+            elsif session = env['rack.session']
+              if session.respond_to?(:id)
+                Timber::Config.instance.debug { "Rack env session detected, using id attribute" }
+                session.id
+              elsif session.respond_to?(:[])
+                Timber::Config.instance.debug { "Rack env session detected, using the session_id key" }
+                session["session_id"]
+              else
+                Timber::Config.instance.debug { "Rack env session detected but could not extract id" }
                 nil
               end
             else
+              Timber::Config.instance.debug { "No session data could be detected, skipping" }
+
               nil
             end
+          rescue Exception => e
+            nil
+          end
+
+          def extract_from_cookie(request, session_key)
+            data = request
+              .cookie_jar
+              .signed_or_encrypted[session_key] || {}
+            data["session_id"]
           end
       end
     end

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

@@ -1,3 +1,5 @@
+require "timber/config"
+require "timber/contexts/user"
 require "timber/integrations/rack/middleware"
 
 module Timber
@@ -79,20 +81,20 @@ module Timber
             # not return a user, in which case the user data might be in the omniauth
             # data.
             if self.class.custom_user_hash.is_a?(Proc)
-              debug { "Obtaining user context from the custom user hash" }
+              Timber::Config.instance.debug { "Obtaining user context from the custom user hash" }
               self.class.custom_user_hash.call(env)
             elsif (auth_hash = env['omniauth.auth'])
-              debug { "Obtaining user context from the omniauth auth hash" }
+              Timber::Config.instance.debug { "Obtaining user context from the omniauth auth hash" }
               get_omniauth_user_hash(auth_hash)
             elsif env[:clearance] && env[:clearance].signed_in?
-              debug { "Obtaining user context from the clearance user" }
+              Timber::Config.instance.debug { "Obtaining user context from the clearance user" }
               user = env[:clearance].current_user
               get_user_object_hash(user)
             elsif env['warden'] && (user = env['warden'].user)
-              debug { "Obtaining user context from the warden user" }
+              Timber::Config.instance.debug { "Obtaining user context from the warden user" }
               get_user_object_hash(user)
             else
-              debug { "Could not locate any user data" }
+              Timber::Config.instance.debug { "Could not locate any user data" }
               nil
             end
           end
@@ -140,17 +142,6 @@ module Timber
               nil
             end
           end
-
-          def debug_logger
-            Timber::Config.instance.debug_logger
-          end
-
-          def debug(&block)
-            if debug_logger
-              message = yield
-              debug_logger.debug(message)
-            end
-          end
       end
     end
   end

data/lib/timber/log_devices/http.rb

@@ -94,7 +94,7 @@ module Timber
         ensure_flush_threads_are_started
 
         if @msg_queue.full?
-          debug { "Flushing HTTP buffer via write" }
+          Timber::Config.instance.debug { "Flushing HTTP buffer via write" }
           flush_async
         end
         true
@@ -122,18 +122,6 @@ module Timber
       end
 
       private
-        def debug_logger
-          Timber::Config.instance.debug_logger
-        end
-
-        # Convenience method for writing debug messages.
-        def debug(&block)
-          if debug_logger
-            message = yield
-            debug_logger.debug(message)
-          end
-        end
-
         # This is a convenience method to ensure the flush thread are
         # started. This is called lazily from {#write} so that we
         # only start the threads as needed, but it also ensures
@@ -172,7 +160,7 @@ module Timber
           @last_async_flush = Time.now
           req = build_request
           if !req.nil?
-            debug { "New request placed on queue" }
+            Timber::Config.instance.debug { "New request placed on queue" }
             @request_queue.enq(req)
           end
         end
@@ -183,10 +171,10 @@ module Timber
           # Wait 20 seconds
           40.times do |i|
             if @request_queue.size == 0 && @requests_in_flight == 0
-              debug { "Request queue is empty and no requests are in flight, finish waiting" }
+              Timber::Config.instance.debug { "Request queue is empty and no requests are in flight, finish waiting" }
               return true
             end
-            debug do
+            Timber::Config.instance.debug do
               "Request size #{@request_queue.size}, reqs in-flight #{@requests_in_flight}, " \
                 "continue waiting (iteration #{i + 1})"
             end
@@ -204,13 +192,13 @@ module Timber
           loop do
             begin
               if intervaled_flush_ready?
-                debug { "Flushing HTTP buffer via the interval" }
+                Timber::Config.instance.debug { "Flushing HTTP buffer via the interval" }
                 flush_async
               end
 
               sleep(0.5)
             rescue Exception => e
-              debug { "Intervaled HTTP flush failed: #{e.inspect}\n\n#{e.backtrace}" }
+              Timber::Config.instance.debug { "Intervaled HTTP flush failed: #{e.inspect}\n\n#{e.backtrace}" }
             end
           end
         end
@@ -225,7 +213,7 @@ module Timber
         # Builds an `Net::HTTP` object to deliver requests over.
         def build_http
           http = Net::HTTP.new(@timber_url.host, @timber_url.port)
-          http.set_debug_output(debug_logger) if debug_logger
+          http.set_debug_output(Config.instance.debug_logger) if Config.instance.debug_logger
           http.use_ssl = true if @timber_url.scheme == 'https'
           http.read_timeout = 30
           http.ssl_timeout = 10
@@ -239,15 +227,15 @@ module Timber
             http = build_http
 
             begin
-              debug { "Starting HTTP connection" }
+              Timber::Config.instance.debug { "Starting HTTP connection" }
 
               http.start do |conn|
                 deliver_requests(conn)
               end
             rescue => e
-              debug { "#request_outlet error: #{e.message}" }
+              Timber::Config.instance.debug { "#request_outlet error: #{e.message}" }
             ensure
-              debug { "Finishing HTTP connection" }
+              Timber::Config.instance.debug { "Finishing HTTP connection" }
               http.finish if http.started?
             end
           end
@@ -261,7 +249,7 @@ module Timber
           num_reqs = 0
 
           while num_reqs < @requests_per_conn
-            debug { "Waiting on next request, threads waiting: #{@request_queue.num_waiting}" }
+            Timber::Config.instance.debug { "Waiting on next request, threads waiting: #{@request_queue.num_waiting}" }
 
             # Blocks waiting for a request.
             req = @request_queue.deq
@@ -270,7 +258,7 @@ module Timber
             begin
               resp = conn.request(req)
             rescue => e
-              debug { "#deliver_request error: #{e.message}" }
+              Timber::Config.instance.debug { "#deliver_request error: #{e.message}" }
 
               @successive_error_count += 1
 
@@ -278,7 +266,7 @@ module Timber
               calculated_backoff = @successive_error_count * 2
               backoff = calculated_backoff > 30 ? 30 : calculated_backoff
 
-              debug { "Backing off #{backoff} seconds, error ##{@successive_error_count}" }
+              Timber::Config.instance.debug { "Backing off #{backoff} seconds, error ##{@successive_error_count}" }
 
               sleep backoff
 
@@ -291,7 +279,7 @@ module Timber
 
             @successive_error_count = 0
             num_reqs += 1
-            debug { "Request successful: #{resp.code}" }
+            Timber::Config.instance.debug { "Request successful: #{resp.code}" }
           end
         end
 

data/lib/timber/logger.rb

@@ -1,6 +1,7 @@
 require "logger"
 require "msgpack"
 
+require "timber/config"
 require "timber/current_context"
 require "timber/event"
 require "timber/log_devices/http"
@@ -195,8 +196,12 @@ module Timber
         args.first.sync = true
       end
 
+      # Set the default formatter. The formatter cannot be set during
+      # initialization, and can be changed with #formatter=.
       if args.size == 1 and args.first.is_a?(LogDevices::HTTP)
         self.formatter = PassThroughFormatter.new
+      elsif Config.instance.development? || Config.instance.test?
+        self.formatter = MessageOnlyFormatter.new
       else
         self.formatter = AugmentedFormatter.new
       end
@@ -205,6 +210,8 @@ module Timber
 
       after_initialize if respond_to?(:after_initialize)
 
+      Timber::Config.instance.debug { "Timber::Logger instantiated, level: #{level}, formatter: #{formatter.class}" }
+
       @initialized = true
     end
 

data/lib/timber/version.rb

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

data/spec/support/timber.rb

@@ -1,3 +1,7 @@
 require "timber"
 require "timber/cli"
-require "timber/cli/io"
+require "timber/cli/io"
+require "timber/config"
+
+config = Timber::Config.instance
+config.environment = "production"

data/spec/timber/cli/installers/rails_spec.rb

@@ -102,7 +102,7 @@ describe Timber::CLI::Installers::Rails, :rails_23 => true do
         and_return("\nend")
 
       logger_code = defined?(ActiveSupport::TaggedLogging) ? "ActiveSupport::TaggedLogging.new(logger)" : "logger"
-      new_contents = "\n\n  # Install the Timber.io logger, send logs over HTTP.\n  # Note: When you are done testing, simply instantiate the logger like this:\n#\n#   logger = Timber::Logger.new(STDOUT)\n#\n# Be sure to remove the \"log_device =\" and \"logger =\" lines below.\n  log_device = Timber::LogDevices::HTTP.new('abcd1234')\n  logger = Timber::Logger.new(log_device)\n  logger.level = config.log_level\n  config.logger = #{logger_code}\n\nend"
+      new_contents = "\n\n  # Install the Timber.io logger, send logs over HTTP.\n    # Note: When you are done testing, simply instantiate the logger like this:\n  #\n  #   logger = Timber::Logger.new(STDOUT)\n  #\n  # Be sure to remove the \"log_device =\" and \"logger =\" lines below.\n  log_device = Timber::LogDevices::HTTP.new('abcd1234')\n  logger = Timber::Logger.new(log_device)\n  logger.level = config.log_level\n  config.logger = #{logger_code}\n\nend"
 
       expect(Timber::CLI::FileHelper).to receive(:write).
         with(env_file_path, new_contents).

data/spec/timber/cli/installers/root_spec.rb

@@ -55,7 +55,7 @@ describe Timber::CLI::Installers::Root, :rails_23 => true do
 
         expect(installer.send(:install_platform, app)).to eq(true)
 
-        copy_to_clipboard_message = Timber::CLI::OSHelper.copy_to_clipboard? ? "\n    \e[32m(✓ copied to clipboard)\e[0m" : ""
+        copy_to_clipboard_message = Timber::CLI::OSHelper.can_copy_to_clipboard? ? "\n    \e[32m(✓ copied to clipboard)\e[0m" : ""
         expected_output = "\n--------------------------------------------------------------------------------\n\nFirst, let's setup your Heroku drain. Run this command in a separate window:\n\n    \e[34mheroku drains:add http://drain.heroku.com\e[0m#{copy_to_clipboard_message}\n\nReady to proceed? (y/n) "
         expect(output.string).to eq(expected_output)
       end

data/spec/timber/integrations/rack/session_context_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+if defined?(::Rack)
+  describe Timber::Integrations::Rack::SessionContext do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+    let(:io) { StringIO.new }
+    let(:logger) do
+      logger = Timber::Logger.new(io)
+      logger.level = ::Logger::INFO
+      logger
+    end
+
+    around(:each) do |example|
+      class RackHttpController < ActionController::Base
+        layout nil
+
+        def index
+          Thread.current[:_timber_context_snapshot] = Timber::CurrentContext.instance.snapshot
+          render json: {}
+        end
+
+        def method_for_action(action_name)
+          action_name
+        end
+      end
+
+      ::RailsApp.routes.draw do
+        get '/rack_http' => 'rack_http#index'
+      end
+
+      with_rails_logger(logger) do
+        Timecop.freeze(time) { example.run }
+      end
+
+      Object.send(:remove_const, :RackHttpController)
+    end
+
+    describe "#process" do
+      it "should set the context" do
+        allow(Benchmark).to receive(:ms).and_return(1).and_yield
+
+        expect_any_instance_of(described_class).to receive(:extract_from_cookie).exactly(1).times.and_return("1234")
+
+        dispatch_rails_request("/rack_http")
+        session_context = Thread.current[:_timber_context_snapshot][:session]
+
+        expect(session_context).to eq({:id => "1234"})
+
+        lines = clean_lines(io.string.split("\n"))
+        expect(lines.length).to eq(3)
+        lines.each do |line|
+          expect(line).to include("\"session\":{\"id\":\"1234\"}")
+        end
+      end
+    end
+
+    # Remove blank lines since Rails does this to space out requests in the logs
+    def clean_lines(lines)
+      lines.select { |line| !line.start_with?(" @metadat") }
+    end
+  end
+end

data/spec/timber/logger_spec.rb

@@ -1,6 +1,27 @@
 require "spec_helper"
 
 describe Timber::Logger, :rails_23 => true do
+  describe "#initialize" do
+    it "shoud select the augmented formatter" do
+      logger = described_class.new(nil)
+      expect(logger.formatter).to be_kind_of(Timber::Logger::AugmentedFormatter)
+    end
+
+    context "development environment" do
+      around(:each) do |example|
+        old_env = Timber::Config.instance.environment
+        Timber::Config.instance.environment = "development"
+        example.run
+        Timber::Config.instance.environment = old_env
+      end
+
+      it "shoud select the augmented formatter" do
+        logger = described_class.new(nil)
+        expect(logger.formatter).to be_kind_of(Timber::Logger::MessageOnlyFormatter)
+      end
+    end
+  end
+
   describe "#add" do
     let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
     let(:io) { StringIO.new }
@@ -124,6 +145,19 @@ describe Timber::Logger, :rails_23 => true do
     end
   end
 
+  describe "#silence" do
+    let(:io) { StringIO.new }
+    let(:logger) { Timber::Logger.new(io) }
+
+    it "should silence the logs" do
+      logger.silence do
+        logger.info("test")
+      end
+
+      expect(io.string).to eq("")
+    end
+  end
+
   describe "#with_context" do
     let(:io) { StringIO.new }
     let(:logger) { Timber::Logger.new(io) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc2
+  version: 2.1.0.rc3
 platform: ruby
 authors:
 - Timber Technologies, Inc.
@@ -267,6 +267,7 @@ files:
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
 - spec/timber/integrations/rack/http_events_spec.rb
+- spec/timber/integrations/rack/session_context_spec.rb
 - spec/timber/integrations/rails/rack_logger_spec.rb
 - spec/timber/log_devices/http_spec.rb
 - spec/timber/log_entry_spec.rb
@@ -331,6 +332,7 @@ test_files:
 - spec/timber/integrations/active_record/log_subscriber_spec.rb
 - spec/timber/integrations/rack/http_context_spec.rb
 - spec/timber/integrations/rack/http_events_spec.rb
+- spec/timber/integrations/rack/session_context_spec.rb
 - spec/timber/integrations/rails/rack_logger_spec.rb
 - spec/timber/log_devices/http_spec.rb
 - spec/timber/log_entry_spec.rb