timber 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4473feee6c4bed1f4a2d42843d6216ee9dc65610
-  data.tar.gz: 9dd9a9da2061ca1c3f01969ec341a08f58afb776
+  metadata.gz: eb90a5dcdaf6811bfa761744ebcb1df521aca6e3
+  data.tar.gz: 92784b6843f7acc7649aa1ff62434c907d7e71ae
 SHA512:
-  metadata.gz: bd0d89058be50f3fea6a55c957abbfb62c883114718e0b744a8833d44a09e2ce2ebb02df55d2d8e2b482e3d3cbfed41d982197dab49fe2ef7f5f1b8e8309929f
-  data.tar.gz: 4b0d17af89a7a89b2ad7933d2be3161798c5430b220dc512e177cf6c2d22285725b61be0ff164d0d9f5be9970e6073e7a8387fd430c2c7284f597e4658b6ffc5
+  metadata.gz: de2fba5e95d5e0ddf11bb753cd7be7986f9ed836c63793583d076280f30312113f40b48f32718654b57394515afea77867d692a625e7cab2a8f6ee19e88c89e8
+  data.tar.gz: e62cd797becc6aa3bbc8ae37b6b44a42ef5d1d27bc8b0ea7c9510078511b04b5e8cebd12c6a8f6c3bbcd4fc2eba4bf553b4ef4df3923558cae91af2fa71fa7a0

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.5.0] - 2017-10-27
+
+### Changed
+
+  - Remove social promotions during the installation process
+  - The default log device for development has been changed to a file (log/development.log)
+    to follow Rails defaults.
+
+### Fixed
+
+  - Adds an override for ActiveSupport::Buffered logger. This is a legacy class that was dropped
+    in Rails >= 4. It lacked #formatter accessor methods, which was a bug that was never resolved.
+
+### Added
+
+  - Capture `content_length` for both HTTP request and HTTP response events. This field is
+    available in the log's metadata. The response event now includes the content length in the
+    actual log message. The request message remains unchanged.
+
 ## [2.4.0] - 2017-10-23
 
 ### Added
@@ -78,7 +97,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     instead of applying back pressure.
 
 
-[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.4.0...HEAD
+[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.5.0...HEAD
+[2.5.0]: https://github.com/timberio/timber-ruby/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/timberio/timber-ruby/compare/v2.3.4...v2.4.0
 [2.3.4]: https://github.com/timberio/timber-ruby/compare/v2.3.3...v2.3.4
 [2.3.3]: https://github.com/timberio/timber-ruby/compare/v2.3.2...v2.3.3

data/README.md

@@ -280,7 +280,7 @@ Logging features designed to help developers get more done:
 
 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)
-3. [**Viw logs per HTTP request.** - See the full story without the noise.](https://timber.io/docs/app/console/trace-http-requests)
+3. [**View logs per HTTP request.** - See the full story without the noise.](https://timber.io/docs/app/console/trace-http-requests)
 4. [**Inspect HTTP request parameters.** - Quickly reproduce issues.](https://timber.io/docs/app/console/inspect-http-requests)
 5. [**Threshold based alerting.** - Know when things break.](https://timber.io/docs/app/alerts)
 6. ...and more! Checkout our [the Timber application docs](https://timber.io/docs/app)

data/lib/timber/cli/api.rb

@@ -159,9 +159,9 @@ module Timber
           else
             res
           end
-        rescue OpenSSL::SSL::SSLError => e
-          if http.ssl_version != :SSLv23
-            http.ssl_version = :SSLv23
+        rescue OpenSSL::SSL::SSLError => _e
+          if http.ssl_version != :TLSv1_2
+            http.ssl_version = :TLSv1_2
             issue!(req)
           end
         end

data/lib/timber/cli/config_file.rb

@@ -58,7 +58,10 @@ module Timber
 config = Timber::Config.instance
 
 #{insert_hook}
-# For a full list of configuration options and their explanations see:
+# For common configuration options see:
+# https://timber.io/docs/languages/ruby/configuration
+#
+# For a full list of configuration options see:
 # http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config
 
 CONTENT

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

@@ -72,12 +72,17 @@ module Timber
 
                 logger_code = <<-CODE
   # Install the Timber.io logger
-  send_logs_to_timber = true # <---- Set to false to stop sending development logs to Timber.io.
-                             #       But do not remove the logger code below! The log_device should
-                             #       be set to STDOUT if you want to disable sending logs.
-
-  log_device = send_logs_to_timber ? Timber::LogDevices::HTTP.new(#{api_key_code}) : STDOUT
-  logger = Timber::Logger.new(log_device)
+  # ----------------------------
+  # Remove the `http_device` to stop sending development logs to Timber.
+  # Be sure to keep the `file_device` or replace it with `STDOUT`.
+  http_device = Timber::LogDevices::HTTP.new(#{api_key_code})
+  file_device = File.open("\#{Rails.root}/log/development.log", "a")
+  file_device.binmode
+  log_devices = [http_device, file_device]
+
+  # Do not modify below this line. It's important to keep the `Timber::Logger`
+  # because it provides an API for logging structured data and capturing context.
+  logger = Timber::Logger.new(*log_devices)
   logger.level = config.log_level
   config.logger = #{config_set_logger_code}
 CODE
@@ -140,7 +145,10 @@ CODE
 
           def install_nil(environment_file_path)
             logger_code = <<-CODE
-  # Install the Timber.io logger, but do not send logs.
+  # Install the Timber.io logger
+  # ----------------------------
+  # `nil` is passed to disable logging. It's important to keep the `Timber::Logger`
+  # because it provides an API for logging structured data and capturing context.
   logger = Timber::Logger.new(nil)
   logger.level = config.log_level
   config.logger = #{config_set_logger_code}

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

@@ -32,7 +32,6 @@ module Timber
           confirm_log_delivery
           api.event(:success)
           collect_feedback
-          free_data
           wrap_up(app)
         end
 
@@ -111,13 +110,6 @@ module Timber
               io.puts "Thank you! We take feedback seriously and will work to improve this."
             end
           end
-
-          def free_data
-            io.puts ""
-            io.puts IO::Messages.separator
-            io.puts ""
-            io.puts IO::Messages.free_data
-          end
       end
     end
   end

data/lib/timber/cli/io/messages.rb

@@ -86,16 +86,6 @@ MESSAGE
           message
         end
 
-        def free_data
-          message = <<-MESSAGE
-Get free data:
-
-* Get ✨ 250mb✨  for starring our repo: #{IO::ANSI.colorize(REPO_URL, :blue)}
-* Get ✨ 250mb✨  for tweeting your experience to #{IO::ANSI.colorize(TWITTER_HANDLE, :blue)}
-MESSAGE
-          message.rstrip
-        end
-
         def header
           message = <<-MESSAGE
 🌲 Timber.io Ruby Installer - Great Ruby Logging Made *Easy*

data/lib/timber/events/http_request.rb

@@ -9,11 +9,12 @@ module Timber
     # @note This event should be installed automatically through integrations,
     #   such as the {Integrations::ActionController::LogSubscriber} integration.
     class HTTPRequest < Timber::Event
-      attr_reader :body, :headers, :host, :method, :path, :port, :query_string, :request_id,
-        :scheme, :service_name
+      attr_reader :body, :content_length, :headers, :host, :method, :path, :port, :query_string,
+        :request_id, :scheme, :service_name
 
       def initialize(attributes)
         @body = attributes[:body] && Util::HTTPEvent.normalize_body(attributes[:body])
+        @content_length = attributes[:content_length]
         @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
         @host = attributes[:host]
         @method = Util::HTTPEvent.normalize_method(attributes[:method]) || raise(ArgumentError.new(":method is required"))
@@ -25,8 +26,9 @@ module Timber
       end
 
       def to_hash
-        {body: body, headers: headers, host: host, method: method, path: path, port: port,
-          query_string: query_string, request_id: request_id, scheme: scheme}
+        {body: body, content_length: content_length, headers: headers, host: host, method: method,
+          path: path, port: port, query_string: query_string, request_id: request_id,
+          scheme: scheme}
       end
       alias to_h to_hash
 

data/lib/timber/events/http_response.rb

@@ -9,10 +9,11 @@ module Timber
     # @note This event should be installed automatically through integrations,
     #   such as the {Integrations::ActionController::LogSubscriber} integration.
     class HTTPResponse < Timber::Event
-      attr_reader :body, :headers, :http_context, :request_id, :service_name, :status, :time_ms
+      attr_reader :body, :content_length, :headers, :http_context, :request_id, :service_name, :status, :time_ms
 
       def initialize(attributes)
         @body = attributes[:body] && Util::HTTPEvent.normalize_body(attributes[:body])
+        @content_length = attributes[:content_length]
         @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
         @http_context = attributes[:http_context]
         @request_id = attributes[:request_id]
@@ -22,7 +23,8 @@ module Timber
       end
 
       def to_hash
-        {body: body, headers: headers, request_id: request_id, status: status, time_ms: time_ms}
+        {body: body, content_length: content_length, headers: headers, request_id: request_id,
+          status: status, time_ms: time_ms}
       end
       alias to_h to_hash
 
@@ -34,10 +36,22 @@ module Timber
       # Returns the human readable log message for this event.
       def message
         if http_context
-          "#{http_context[:method]} #{http_context[:path]} sent #{status} #{status_description} " \
-            "in #{time_ms}ms"
+          message = "#{http_context[:method]} #{http_context[:path]} completed with " \
+            "#{status} #{status_description} "
+
+          if content_length
+            message += ", #{content_length} bytes, "
+          end
+
+          message + "in #{time_ms}ms"
         else
-          "Completed #{status} #{status_description} in #{time_ms}ms"
+          message = "Completed #{status} #{status_description} "
+
+          if content_length
+            message += ", #{content_length} bytes, "
+          end
+
+          message + "in #{time_ms}ms"
         end
       end
 

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

@@ -106,6 +106,8 @@ module Timber
           end
         end
 
+        CONTENT_LENGTH_KEY = 'Content-Length'.freeze
+
         def call(env)
           request = Util::Request.new(env)
 
@@ -126,9 +128,11 @@ module Timber
             Config.instance.logger.info do
               http_context_key = Contexts::HTTP.keyspace
               http_context = CurrentContext.fetch(http_context_key)
+              content_length = headers[CONTENT_LENGTH_KEY]
               time_ms = (Time.now - start) * 1000.0
 
               Events::HTTPResponse.new(
+                content_length: content_length,
                 headers: headers,
                 http_context: http_context,
                 request_id: request.request_id,
@@ -147,6 +151,7 @@ module Timber
 
               Events::HTTPRequest.new(
                 body: event_body,
+                content_length: request.content_length,
                 headers: request.headers,
                 host: request.host,
                 method: request.request_method,
@@ -161,11 +166,13 @@ module Timber
             status, headers, body = @app.call(env)
 
             Config.instance.logger.info do
-              time_ms = (Time.now - start) * 1000.0
               event_body = capture_response_body? ? body : nil
+              content_length = headers[CONTENT_LENGTH_KEY]
+              time_ms = (Time.now - start) * 1000.0
 
               Events::HTTPResponse.new(
                 body: event_body,
+                content_length: content_length,
                 headers: headers,
                 request_id: request.request_id,
                 status: status,

data/lib/timber/overrides.rb

@@ -1,6 +1,7 @@
 # The order is relevant
 require "timber/overrides/active_support_3_tagged_logging"
 require "timber/overrides/active_support_tagged_logging"
+require "timber/overrides/active_support_buffered_logger"
 require "timber/overrides/lograge"
 require "timber/overrides/rails_stdout_logging"
 

data/lib/timber/overrides/active_support_3_tagged_logging.rb

@@ -1,3 +1,8 @@
+# Please note, this patch is merely an upgrade, backporting improved tagged logging code
+# from newer versions of Rails:
+# https://github.com/rails/rails/blob/5-1-stable/activesupport/lib/active_support/tagged_logging.rb
+# The behavior of tagged logging will not change in any way.
+#
 # This patch is specifically for Rails 3. The legacy approach to wrapping the logger in
 # ActiveSupport::TaggedLogging is rather poor, hence the reason it was changed entirely
 # for Rails 4 and 5. The problem is that ActiveSupport::TaggedLogging is a wrapping
@@ -79,9 +84,12 @@ begin
         end
 
         def self.new(logger)
-          # Ensure we set a default formatter so we aren't extending nil!
-          logger.formatter ||= SimpleFormatter.new
-          logger.formatter.extend Formatter
+          if logger.respond_to?(:formatter=) && logger.respond_to?(:formatter)
+            # Ensure we set a default formatter so we aren't extending nil!
+            logger.formatter ||= SimpleFormatter.new
+            logger.formatter.extend Formatter
+          end
+
           logger.extend(self)
         end
 

data/lib/timber/overrides/active_support_buffered_logger.rb

@@ -0,0 +1,22 @@
+# This adds a #formatter and #formatter= method to the legacy ActiveSupport::BufferedLogger
+# class. This bug was never resolved due to it being phased out past Rails >= 4.
+
+begin
+  require "active_support/buffered_logger"
+
+  class ActiveSupport::BufferedLogger
+    def formatter
+      if @log.respond_to?(:formatter)
+        @log.formatter
+      end
+    end
+
+    def formatter=(value)
+      if @log.respond_to?(:formatter=)
+        @log.formatter = value
+      end
+    end
+  end
+
+rescue Exception
+end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/spec/rails/tagged_logging_spec.rb

@@ -3,6 +3,20 @@ require "spec_helper"
 # ActiveSupport::TaggedLogging is not defined in <= 3.1
 if defined?(::ActiveSupport::TaggedLogging)
   describe ActiveSupport::TaggedLogging, :rails_23 => true do
+    describe "#new" do
+      let(:io) { StringIO.new }
+
+      it "should instantiate for Timber::Logger object" do
+        ActiveSupport::TaggedLogging.new(Timber::Logger.new(io))
+      end
+
+      if defined?(ActiveSupport::BufferedLogger)
+        it "should instantiate for a ActiveSupport::BufferedLogger object" do
+          ActiveSupport::TaggedLogging.new(ActiveSupport::BufferedLogger.new(io))
+        end
+      end
+    end
+
     describe "#info" do
       let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
       let(:io) { StringIO.new }

data/spec/support/rails.rb

@@ -30,6 +30,7 @@ if defined?(::Rails)
         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["CONTENT_LENGTH"] = 100
         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"]

data/spec/timber/cli/config_file_spec.rb

@@ -5,7 +5,7 @@ describe Timber::CLI::ConfigFile, :rails_23 => true do
   let(:file_helper) { @file_helper = Timber::CLI::FileHelper.new(api) }
   let(:path) { "config/initializers/timber.rb" }
   let(:config_file) { described_class.new(path, file_helper) }
-  let(:initial_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For a full list of configuration options and their explanations see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
+  let(:initial_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For common configuration options see:\n# https://timber.io/docs/languages/ruby/configuration\n#\n# For a full list of configuration options see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
   let(:contents_hook) { "# Add additional configuration here." }
 
   describe ".create!" do

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

@@ -17,7 +17,7 @@ describe Timber::CLI::Installers::ConfigFile, :rails_23 => true do
   let(:output) { StringIO.new }
   let(:io) { Timber::CLI::IO.new(io_out: output, io_in: input) }
   let(:installer) { described_class.new(io, api) }
-  let(:initial_config_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For a full list of configuration options and their explanations see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
+  let(:initial_config_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For common configuration options see:\n# https://timber.io/docs/languages/ruby/configuration\n#\n# For a full list of configuration options see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
 
   describe ".run" do
     it "should run properly" do

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

@@ -95,12 +95,17 @@ describe Timber::CLI::Installers::Rails, :rails_23 => true do
 
             expected_code = <<-CODE
   # Install the Timber.io logger
-  send_logs_to_timber = true # <---- Set to false to stop sending development logs to Timber.io.
-                             #       But do not remove the logger code below! The log_device should
-                             #       be set to STDOUT if you want to disable sending logs.
-
-  log_device = send_logs_to_timber ? Timber::LogDevices::HTTP.new('#{app.api_key}') : STDOUT
-  logger = Timber::Logger.new(log_device)
+  # ----------------------------
+  # Remove the `http_device` to stop sending development logs to Timber.
+  # Be sure to keep the `file_device` or replace it with `STDOUT`.
+  http_device = Timber::LogDevices::HTTP.new('#{app.api_key}')
+  file_device = File.open("\#{Rails.root}/log/development.log", "a")
+  file_device.binmode
+  log_devices = [http_device, file_device]
+
+  # Do not modify below this line. It's important to keep the `Timber::Logger`
+  # because it provides an API for logging structured data and capturing context.
+  logger = Timber::Logger.new(*log_devices)
   logger.level = config.log_level
   config.logger = #{logger_code}
 CODE
@@ -314,7 +319,10 @@ CODE
       env_file_path = "config/environments/development.rb"
 
       expected_code = <<-CODE
-  # Install the Timber.io logger, but do not send logs.
+  # Install the Timber.io logger
+  # ----------------------------
+  # `nil` is passed to disable logging. It's important to keep the `Timber::Logger`
+  # because it provides an API for logging structured data and capturing context.
   logger = Timber::Logger.new(nil)
   logger.level = config.log_level
   config.logger = #{logger_code}

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

@@ -30,7 +30,6 @@ describe Timber::CLI::Installers::Root, :rails_23 => true do
       expect(installer).to receive(:wrap_up).with(app).exactly(1).times
       expect(api).to receive(:event).with(:success).exactly(1).times
       expect(installer).to receive(:collect_feedback).exactly(1).times
-      expect(installer).to receive(:free_data).exactly(1).times
 
       installer.run(app)
     end

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

@@ -88,7 +88,7 @@ if defined?(::Rack)
           expect(lines.length).to eq(2)
 
           expect(lines[0]).to start_with("Processing by RackHttpController#index as HTML @metadata ")
-          expect(lines[1]).to start_with("GET /rack_http sent 200 OK in 0.0ms @metadata ")
+          expect(lines[1]).to start_with("GET /rack_http completed with 200 OK in 0.0ms @metadata ")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -235,6 +235,7 @@ files:
 - lib/timber/logger.rb
 - lib/timber/overrides.rb
 - lib/timber/overrides/active_support_3_tagged_logging.rb
+- lib/timber/overrides/active_support_buffered_logger.rb
 - lib/timber/overrides/active_support_tagged_logging.rb
 - lib/timber/overrides/lograge.rb
 - lib/timber/overrides/rails_stdout_logging.rb