timber 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8e5de46982d4346797f2fcefba7f45d601bc6cd
-  data.tar.gz: 2a46a4fbc36cb8b6de0901cb138aeb7249ddd931
+  metadata.gz: 39440c7ae6a4d416b54191200b5a406681750be5
+  data.tar.gz: 04de3467c2bc3bdc363d1816ea892a74b4b237cc
 SHA512:
-  metadata.gz: 81c9834d338f1d54f15df5c36802e761c3725da1cc36de4c46992fc7cc536ff6d0630678666937d22e0181dffdc7c1790ff2c4a4046732d8cdf352ccee60cb36
-  data.tar.gz: 8167bb8a446d336b4f798da86f10d66b1b67cba12f1d95f4c0a1be828d08526add3346916451f4a02226f469320c476a43ff1372a2f67384d68500e63a0553a9
+  metadata.gz: c2d65105138fa4e900262dc15274c4a4dbc79b1ecb89a91ffedefcdc64371933d12e5157cb16ffe8999e48375255d2186f7e0cd62ab30efafe13ee9074d2d2a8
+  data.tar.gz: 9e1562e6465a72a7e491841617d58ec5dd1dd10d6174a34a92fba8817fcd80e9d8433555c7e1ead74022fd0bb90b314dc3b3ea8cbb78b61c31c92dba8dcda6a7

data/README.md

@@ -15,10 +15,10 @@
 
 Timber for Ruby is an optional upgrade you can install for Ruby apps on the
 [Timber.io logging platform](https://timber.io). Instead of completely replacing your log messages,
-Timber automatically augments your logs with JSON metadata. Essentially turning them into
+Timber efficiently augments your logs with critical metadata. Turning them into
 [rich events with context](https://timber.io/docs/ruby/events-and-context). 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.
+readability of your logs while still adding the critical context needed to properly analyze your
+logs.
 
 
 ## How it works
@@ -61,21 +61,6 @@ For a complete overview, see the [Timber for Ruby docs](https://timber.io/docs/r
 3. In your `shell`, run `bundle exec timber install`
 
 
-## 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:
-
-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++.
-
-
-
 ## Usage
 
 <details><summary><strong>Basic logging</strong></summary><p>
@@ -88,8 +73,6 @@ logger.info("My log message")
 # => My log message @metadata {"level": "info", "context": {...}}
 ```
 
-Timber will *never* deviate from the public `::Logger` interface in *any* way.
-
 ---
 
 </p></details>
@@ -100,7 +83,7 @@ Custom events allow you to extend beyond events already defined in
 the [`Timber::Events`](lib/timber/events) namespace.
 
 ```ruby
-Logger.warn "Payment rejected", payment_rejected: {customer_id: "abcd1234", amount: 100, reason: "Card expired"}
+logger.warn "Payment rejected", payment_rejected: {customer_id: "abcd1234", amount: 100, reason: "Card expired"}
 
 # => Payment rejected @metadata {"level": "warn", "event": {"payment_rejected": {"customer_id": "abcd1234", "amount": 100, "reason": "Card expired"}}, "context": {...}}
 ```
@@ -120,7 +103,7 @@ Custom contexts allow you to extend beyond contexts already defined in
 the [`Timber::Contexts`](lib/timber/contexts) namespace.
 
 ```ruby
-Timber::CurrentContext.with({build: {version: "1.0.0"}}) do
+logger.with_context(build: {version: "1.0.0"}) do
   logger.info("My log message")
 end
 

data/benchmarks/rails.rb

@@ -0,0 +1,122 @@
+require 'benchmark'
+require 'benchmark-memory'
+require 'bundler/setup'
+require 'rails'
+require 'action_controller'
+
+io = StringIO.new # ensure we are logging to something
+logger = Logger.new(io)
+logger.level = Logger::DEBUG
+Rails.logger = logger
+
+#
+# Setup
+#
+
+# Setup the rails app to test
+class RailsApp < Rails::Application
+  if ::Rails.version =~ /^3\./
+    config.secret_token = '1e05af2b349457936a41427e63450937'
+  else
+    config.secret_key_base = '1e05af2b349457936a41427e63450937'
+  end
+
+  # This ensures our tests fail, otherwise exceptions get swallowed by ActionDispatch::DebugExceptions
+  config.action_dispatch.show_exceptions = false
+  config.active_support.deprecation = :stderr
+  config.eager_load = false
+end
+
+# Create a controller to test against
+class HomeController < ActionController::Base
+  layout nil
+
+  def index
+    render json: {}
+  end
+
+  def method_for_action(action_name)
+    action_name
+  end
+end
+
+# Define the routes
+::RailsApp.routes.draw do
+  get '/' => 'home#index'
+end
+
+# Initialize the app
+RailsApp.initialize!
+
+# Helper function to issue requests.
+def dispatch_rails_request(path, additional_env_options = {})
+  application = ::Rails.application
+  env = application.respond_to?(:env_config) ? application.env_config.clone : application.env_defaults.clone
+  env["rack.request.cookie_hash"] = {}.with_indifferent_access
+  env["REMOTE_ADDR"] = "123.456.789.10"
+  env["HTTP_X_REQUEST_ID"] = "unique-request-id-1234"
+  env["action_dispatch.request_id"] = env["HTTP_X_REQUEST_ID"]
+  env = env.merge(additional_env_options)
+  ::Rack::MockRequest.new(application).get(path, env)
+end
+
+# How many iterations to perform
+iterations = 1_000
+
+puts "############################################################"
+puts ""
+puts "Testing Without Timber (#{iterations} iterations)"
+puts ""
+puts "############################################################"
+puts
+
+# Use bmbm to mimimize initial GC differences.
+puts "Timing via benchmark:"
+puts ""
+
+Benchmark.bmbm do |x|
+  x.report("Without Timber") { iterations.times { dispatch_rails_request("/") } }
+end
+
+puts "\n"
+puts "Memory profiling via benchmark-memory:"
+puts
+
+Benchmark.memory do |x|
+  x.report("Without Timber") { iterations.times { dispatch_rails_request("/") } }
+end
+
+puts "\n\n\n\n"
+puts "############################################################"
+puts ""
+puts "Testing With Timber (#{iterations} iterations)"
+puts ""
+puts "############################################################"
+puts ""
+
+# Integrate Timber (this is handled in our Railtie, but we cna't use that here since we already
+# initialized the app.)
+require 'timber'
+io = StringIO.new # ensure we are logging to something
+logger = Timber::Logger.new(io)
+logger.level = Logger::DEBUG
+Timber::Frameworks::Rails.set_logger(logger)
+Timber::Frameworks::Rails.configure_middlewares(Rails.application.config.app_middleware)
+Timber::Integrations.integrate!
+Timber::Config.instance.append_metadata = false
+
+
+puts "Timing via benchmark:"
+puts ""
+
+Benchmark.bmbm do |x|
+  x.report("With Timber")  { iterations.times { dispatch_rails_request("/") } }
+end
+
+puts "\n"
+puts "Memory profiling via benchmark-memory:"
+puts ""
+
+Benchmark.memory do |x|
+  x.report("With Timber") { iterations.times { dispatch_rails_request("/") } }
+end

data/lib/timber/cli/api.rb

@@ -44,6 +44,13 @@ module Timber
           yield iteration
         end
 
+        case iteration
+        when 0
+          event!(:waiting_for_logs)
+        when 30
+          event!(:excessively_waiting_for_logs)
+        end
+
         sleep 0.5
 
         res = get!(HAS_LOGS_PATH)

data/lib/timber/cli/install.rb

@@ -29,10 +29,10 @@ module Timber
           puts Messages.application_details(app)
           puts ""
 
-          case ask_yes_no("Are the above details correct?")
+          case ask_yes_no("Are the above details correct?", api)
           when :yes
             if app.heroku?
-              update_environment_config("production", :stdout)
+              update_environment_config("production", :stdout, api)
 
               puts ""
               puts Messages.separator
@@ -40,7 +40,7 @@ module Timber
               puts Messages.heroku_install(app)
               puts ""
 
-              ask_yes_no("Ready to proceed?")
+              ask_yes_no("Ready to proceed?", api)
               puts ""
 
             else
@@ -53,19 +53,19 @@ module Timber
               puts "2) Configuring in my app"
               puts ""
 
-              case ask("Enter your choice: (1/2) ")
+              case ask("Enter your choice: (1/2) ", api)
               when "1"
-                update_environment_config("production", :http, :api_key_code => "ENV['TIMBER_API_KEY']")
+                update_environment_config("production", :http, api, :api_key_code => "ENV['TIMBER_API_KEY']")
 
                 puts ""
                 puts Messages.http_environment_variables(app.api_key)
                 puts ""
 
-                ask_yes_no("Ready to proceed?")
+                ask_yes_no("Ready to proceed?", api)
                 puts ""
 
               when "2"
-                update_environment_config("production", :http, :api_key_code => "'#{app.api_key}'")
+                update_environment_config("production", :http, api, :api_key_code => "'#{app.api_key}'")
 
               end
 
@@ -107,7 +107,7 @@ module Timber
         end
 
         private
-          def update_environment_config(name, log_device_type, options = {})
+          def update_environment_config(name, log_device_type, api, options = {})
             path = File.join("config", "environments", "#{name}.rb")
 
             puts ""
@@ -146,6 +146,7 @@ CODE
             if !current_contents.include?("Timber::Logger.new")
               new_contents = current_contents.sub(/\nend/, "\n\n#{logger_code}\nend")
               File.write(path, new_contents)
+              api.event!(:file_written, path: path)
             end
 
             puts colorize(Messages.task_complete(task_message), :green)
@@ -156,7 +157,9 @@ CODE
 
             http_device = LogDevices::HTTP.new(api_key)
             logger = Logger.new(http_device)
-            logger.info("test")
+            logger.info("Welcome to Timber!")
+            logger.info("This is a test log to ensure the pipes are working")
+            logger.info("Be sure to commit and deploy your app to start seeing real logs")
 
             puts colorize(Messages.task_complete("Sending test logs"), :green)
           end
@@ -165,7 +168,9 @@ CODE
             puts ""
             puts Messages.separator
             puts ""
-            rating = ask("How would rate this install experience? 1 (bad) - 5 (perfect)")
+
+            rating = ask("How would rate this install experience? 1 (bad) - 5 (perfect)", api)
+
             case rating
             when "4", "5"
               api.event!(:feedback, rating: rating.to_i)
@@ -177,7 +182,7 @@ CODE
               puts Messages.bad_experience_message
               puts ""
 
-              comments = ask("Type your comments (enter sends)")
+              comments = ask("Type your comments (enter sends)", api)
 
               api.event!(:feedback, rating: rating.to_i, comments: comments)
 

data/lib/timber/cli/io_helper.rb

@@ -1,20 +1,26 @@
 module Timber
   class CLI
     module IOHelper
-      def ask(message)
+      def ask(message, api)
+        api.event!(:waiting_for_input, prompt: message)
+
         write message + " "
-        gets
+        input = gets
+
+        api.event!(:received_input, prompt: message, value: input)
+
+        input
       end
 
-      def ask_yes_no(message)
-        case ask(message + " (y/n)")
+      def ask_yes_no(message, api)
+        case ask(message + " (y/n)", api)
         when "y", "Y"
           :yes
         when "n", "N"
           :no
         else
           puts "Woops! That's not a valid input. Please try again."
-          ask_yes_no(message)
+          ask_yes_no(message, api)
         end
       end
 

data/lib/timber/cli/messages.rb

@@ -45,8 +45,7 @@ message.rstrip
 message = <<-MESSAGE
 Last step! Commit and deploy:
 
-    #{colorize("git add config/initializers/timber.rb", :blue)}
-    #{colorize("git commit -am 'Install Timber'", :blue)}
+    #{colorize("git commit -m 'Install Timber' config/environments/production.rb", :blue)}
 
     #{colorize("push and deploy", :blue)} 🚀
 MESSAGE

data/lib/timber/contexts/custom.rb

@@ -3,8 +3,7 @@ module Timber
     # Custom contexts allow you to add application specific context not covered elsewhere.
     #
     # @example Adding a context
-    #   custom_context = Timber::Contexts::Custom.new(type: :keyspace, data: %{my: "data"})
-    #   Timber::CurrentContext.with(custom_context) do
+    #   logger.with_context(build: {version: "1.0.0"}) do
     #     # ... anything logged here will have the context ...
     #   end
     class Custom < Context

data/lib/timber/contexts/organization.rb

@@ -10,7 +10,7 @@ module Timber
     # Example:
     #
     #   organization_context = Timber::Contexts::Organization.new(id: "abc1234", name: "Timber Inc")
-    #   Timber::CurrentContext.with(organization_context) do
+    #   logger.with_context(organization_context) do
     #     # Logging will automatically include this context
     #     logger.info("This is a log message")
     #   end

data/lib/timber/events/http_client_request.rb

@@ -13,7 +13,7 @@ module Timber
         @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
         @host = attributes[:host] || raise(ArgumentError.new(":host is required"))
         @method = Util::HTTPEvent.normalize_method(attributes[:method]) || raise(ArgumentError.new(":method is required"))
-        @path = attributes[:path] || raise(ArgumentError.new(":path is required"))
+        @path = attributes[:path]
         @port = attributes[:port]
         @query_string = Util::HTTPEvent.normalize_query_string(attributes[:query_string])
         @request_id = attributes[:request_id]

data/lib/timber/events/http_server_request.rb

@@ -13,7 +13,7 @@ module Timber
         @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
         @host = attributes[:host] || raise(ArgumentError.new(":host is required"))
         @method = Util::HTTPEvent.normalize_method(attributes[:method]) || raise(ArgumentError.new(":method is required"))
-        @path = attributes[:path] || raise(ArgumentError.new(":path is required"))
+        @path = attributes[:path]
         @port = attributes[:port]
         @query_string = Util::HTTPEvent.normalize_query_string(attributes[:query_string])
         @scheme = attributes[:scheme] || raise(ArgumentError.new(":scheme is required"))

data/lib/timber/logger.rb

@@ -212,6 +212,12 @@ module Timber
       super
     end
 
+    # Convenience method for adding context. Please see {{Timber::CurrentContext.with}} for
+    # a more detailed description and examples.
+    def with_context(context, &block)
+      Timber::CurrentContext.with(context, &block)
+    end
+
     # Backwards compatibility with older ActiveSupport::Logger versions
     Logger::Severity.constants.each do |severity|
       class_eval(<<-EOT, __FILE__, __LINE__ + 1)

data/lib/timber/util/http_event.rb

@@ -34,7 +34,10 @@ module Timber
               if Config.instance.header_filters && Config.instance.header_filters.include?(k)
                 h[k] = SANITIZED_VALUE
               else
-                h[k] = v
+                # Force the header into a valid UTF-8 string, otherwise we will encounter
+                # encoding issues when we convert this data to json. Moreoever, if the
+                # data is already valid UTF-8 we don't pay a penalty.
+                h[k] = Timber::Util::String.normalize_to_utf8(v)
               end
             end
           end

data/lib/timber/util/string.rb

@@ -0,0 +1,21 @@
+module Timber
+  module Util
+    # @private
+    module String
+      UTF8 = "UTF-8".freeze
+
+      # @private
+      def self.normalize_to_utf8(string)
+        if string.encoding.to_s == UTF8
+          string
+        else
+          string.encode('UTF-8', {
+            :invalid => :replace,
+            :undef   => :replace,
+            :replace => '?'
+          })
+        end
+      end
+    end
+  end
+end

data/lib/timber/util.rb

@@ -3,6 +3,7 @@ require "timber/util/hash"
 require "timber/util/http_event"
 require "timber/util/object"
 require "timber/util/request"
+require "timber/util/string"
 require "timber/util/struct"
 
 module Timber

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.7"
+  VERSION = "2.0.8"
 end

data/spec/timber/events/http_server_request_spec.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe Timber::Events::HTTPServerRequest, :rails_23 => true do
+  describe ".initialize" do
+    context "with a header filters" do
+      around(:each) do |example|
+        old_header_filters = Timber::Config.instance.header_filters
+        Timber::Config.instance.header_filters += ['api-key']
+        example.run
+        Timber::Config.instance.header_filters = old_header_filters
+      end
+
+      it "should sanitize headers when a config option is set" do
+        event = described_class.new(:headers => {'Api-Key' => 'abcde'}, :host => 'my.host.com', :method => 'GET', :path => '/path', :scheme => 'https')
+        expect(event.headers).to eq({'api-key' => '[sanitized]'})
+      end
+    end
+
+    it "should handle header encoding" do
+      referer = 'http://www.metrojobb.se/jobb/1013893-skadeadministratör'.force_encoding('ASCII-8BIT')
+      event = described_class.new(:headers => {'Referer' => referer}, :host => 'my.host.com', :method => 'GET', :path => '/path', :scheme => 'https')
+      expect(event.headers["referer"].encoding.to_s).to eq("UTF-8")
+    end
+  end
+end

data/spec/timber/log_entry_spec.rb

@@ -1,9 +1,9 @@
 require "spec_helper"
 
 describe Timber::LogEntry, :rails_23 => true do
-  describe "#to_msgpack" do
-    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+  let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
 
+  describe "#to_msgpack" do
     it "should encode properly with an event and context" do
       event = Timber::Events::Custom.new(type: :event_type, message: "event_message", data: {a: 1})
       context = {custom: Timber::Contexts::Custom.new(type: :context_type, data: {b: 1})}

data/spec/timber/logger_spec.rb

@@ -133,6 +133,27 @@ describe Timber::Logger, :rails_23 => true do
     end
   end
 
+  describe "#with_context" do
+    let(:io) { StringIO.new }
+    let(:logger) { Timber::Logger.new(io) }
+
+    it "should add context" do
+      expect(Timber::CurrentContext.hash).to eq({})
+
+      logger.with_context(build: {version: "1.0.0"}) do
+        expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
+
+        logger.with_context({testing: {key: "value"}}) do
+          expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}, :testing=>{:key=>"value"}}})
+        end
+
+        expect(Timber::CurrentContext.hash).to eq({:custom=>{:build=>{:version=>"1.0.0"}}})
+      end
+
+      expect(Timber::CurrentContext.hash).to eq({})
+    end
+  end
+
   describe "#info" do
     let(:io) { StringIO.new }
     let(:logger) { Timber::Logger.new(io) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -137,6 +137,7 @@ files:
 - Gemfile
 - LICENSE.md
 - README.md
+- benchmarks/rails.rb
 - bin/timber
 - gemfiles/rails-3.0.gemfile
 - gemfiles/rails-3.1.gemfile
@@ -208,6 +209,7 @@ files:
 - lib/timber/util/http_event.rb
 - lib/timber/util/object.rb
 - lib/timber/util/request.rb
+- lib/timber/util/string.rb
 - lib/timber/util/struct.rb
 - lib/timber/version.rb
 - spec/README.md
@@ -229,6 +231,7 @@ files:
 - spec/timber/current_context_spec.rb
 - spec/timber/event_spec.rb
 - spec/timber/events/custom_spec.rb
+- spec/timber/events/http_server_request_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/integrations/action_controller/log_subscriber_spec.rb
 - spec/timber/integrations/action_dispatch/debug_exceptions_spec.rb
@@ -283,6 +286,7 @@ test_files:
 - spec/timber/current_context_spec.rb
 - spec/timber/event_spec.rb
 - spec/timber/events/custom_spec.rb
+- spec/timber/events/http_server_request_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/integrations/action_controller/log_subscriber_spec.rb
 - spec/timber/integrations/action_dispatch/debug_exceptions_spec.rb