timber 1.0.13 → 1.1.0

data/spec/timber/probes/action_dispatch_debug_exceptions_spec.rb

@@ -39,7 +39,7 @@ describe Timber::Probes::ActionDispatchDebugExceptions do
         # Because constantly updating the line numbers sucks :/
         expect(io.string).to include("RuntimeError (boom):\\n\\n")
         expect(io.string).to include("@timber.io")
-        expect(io.string).to include("\"event\":{\"exception\":{\"name\":\"RuntimeError\",\"message\":\"boom\",\"backtrace\":[\"")
+        expect(io.string).to include("\"event\":{\"server_side_app\":{\"exception\":{\"name\":\"RuntimeError\",\"message\":\"boom\",\"backtrace\":[\"")
       end
 
       def mock_class

data/spec/timber/probes/action_view_log_subscriber_spec.rb

@@ -51,8 +51,8 @@ describe Timber::Probes::ActionViewLogSubscriber do
           it "should log the controller call event" do
             allow_any_instance_of(Timber::Probes::ActionViewLogSubscriber::LogSubscriber).to receive(:logger).and_return(logger)
             dispatch_rails_request("/action_view_log_subscriber")
-            message = "  Rendered spec/support/rails/templates/template.html (0.0ms) @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"template_render\":{\"name\":\"spec/support/rails/templates/template.html\",\"time_ms\":0.0}},\"context\":{\"http\":{\"method\":\"GET\",\"path\":\"/action_view_log_subscriber\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}}\n"
-            expect(io.string).to eq(message)
+            expect(io.string).to start_with("  Rendered spec/support/rails/templates/template.html (0.0ms) @timber.io {\"level\":\"info\"")
+            expect(io.string).to include("\"event\":{\"server_side_app\":{\"template_render\":{\"name\":\"spec/support/rails/templates/template.html\",\"time_ms\":0.0}}},")
           end
         end
       end

data/spec/timber/probes/rails_rack_logger_spec.rb

@@ -33,13 +33,13 @@ describe Timber::Probes::RailsRackLogger do
     end
 
     describe "#started_request_message" do
-      it "should set the context" do
+      it "should add the request event" do
         allow(::Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new("production")) # Rails 3.2.X
         allow(::Rails).to receive(:logger).and_return(logger) # Rails 3.2.X
         allow_any_instance_of(::Rails::Rack::Logger).to receive(:logger).and_return(logger)
         dispatch_rails_request("/rails_rack_logger")
-        message = "Started GET \"/rails_rack_logger\" for 123.456.789.10 @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"http_request\":{\"host\":\"example.org\",\"method\":\"GET\",\"path\":\"/rails_rack_logger\",\"port\":80,\"headers\":{\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}},\"context\":{\"http\":{\"method\":\"GET\",\"path\":\"/rails_rack_logger\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}}\n"
-        expect(io.string).to eq(message)
+        expect(io.string).to start_with("Started GET \"/rails_rack_logger\" for 123.456.789.10 @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
+        expect(io.string).to include("\"event\":{\"server_side_app\":{\"http_request\":{\"host\":\"example.org\",\"method\":\"GET\",\"path\":\"/rails_rack_logger\",\"port\":80,\"headers\":{\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}}")
       end
     end
   end

data/spec/timber/rack_middlewares/http_context_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe Timber::RackMiddlewares::HTTPContext 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] = 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
+
+    Timecop.freeze(time) { example.run }
+
+    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
+      allow_any_instance_of(Timber::Probes::ActionControllerLogSubscriber::LogSubscriber).to receive(:logger).and_return(logger)
+
+      dispatch_rails_request("/rack_http")
+      http_context = Thread.current[:_timber_context][:http]
+
+      expect(http_context).to eq({:method=>"GET", :path=>"/rack_http", :remote_addr=>"123.456.789.10", :request_id=>"unique-request-id-1234"})
+      expect(io.string).to include("\"http\":{\"method\":\"GET\",\"path\":\"/rack_http\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}")
+    end
+  end
+end

data/timber.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency("msgpack", "~> 1.0")
+  s.add_development_dependency("appraisal", "~> 2.1")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.0
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: 
 email:
 - hi@timber.io
@@ -46,7 +60,8 @@ files:
 - lib/timber/contexts/custom.rb
 - lib/timber/contexts/http.rb
 - lib/timber/contexts/organization.rb
-- lib/timber/contexts/tags.rb
+- lib/timber/contexts/runtime.rb
+- lib/timber/contexts/system.rb
 - lib/timber/contexts/user.rb
 - lib/timber/current_context.rb
 - lib/timber/event.rb
@@ -54,8 +69,8 @@ files:
 - lib/timber/events/controller_call.rb
 - lib/timber/events/custom.rb
 - lib/timber/events/exception.rb
-- lib/timber/events/http_request.rb
-- lib/timber/events/http_response.rb
+- lib/timber/events/http_server_request.rb
+- lib/timber/events/http_server_response.rb
 - lib/timber/events/sql_query.rb
 - lib/timber/events/template_render.rb
 - lib/timber/frameworks.rb
@@ -74,12 +89,15 @@ files:
 - lib/timber/probes/active_record_log_subscriber.rb
 - lib/timber/probes/active_record_log_subscriber/log_subscriber.rb
 - lib/timber/probes/active_support_tagged_logging.rb
-- lib/timber/probes/rack_http_context.rb
 - lib/timber/probes/rails_rack_logger.rb
+- lib/timber/rack_middlewares.rb
+- lib/timber/rack_middlewares/http_context.rb
 - lib/timber/util.rb
 - lib/timber/util/active_support_log_subscriber.rb
 - lib/timber/util/hash.rb
+- lib/timber/util/struct.rb
 - lib/timber/version.rb
+- spec/README.md
 - spec/spec_helper.rb
 - spec/support/action_controller.rb
 - spec/support/action_view.rb
@@ -93,15 +111,17 @@ files:
 - spec/support/timber.rb
 - spec/support/timecop.rb
 - spec/support/webmock.rb
+- spec/timber/contexts_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/log_devices/http_spec.rb
+- spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/probes/action_controller_log_subscriber_spec.rb
 - spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
 - spec/timber/probes/action_view_log_subscriber_spec.rb
 - spec/timber/probes/active_record_log_subscriber_spec.rb
-- spec/timber/probes/rack_http_context_spec.rb
 - spec/timber/probes/rails_rack_logger_spec.rb
+- spec/timber/rack_middlewares/http_context_spec.rb
 - timber.gemspec
 homepage: https://github.com/timberio/timber-ruby
 licenses: []
@@ -127,6 +147,7 @@ signing_key:
 specification_version: 4
 summary: Instant log gratification.
 test_files:
+- spec/README.md
 - spec/spec_helper.rb
 - spec/support/action_controller.rb
 - spec/support/action_view.rb
@@ -140,12 +161,14 @@ test_files:
 - spec/support/timber.rb
 - spec/support/timecop.rb
 - spec/support/webmock.rb
+- spec/timber/contexts_spec.rb
 - spec/timber/events_spec.rb
 - spec/timber/log_devices/http_spec.rb
+- spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/probes/action_controller_log_subscriber_spec.rb
 - spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
 - spec/timber/probes/action_view_log_subscriber_spec.rb
 - spec/timber/probes/active_record_log_subscriber_spec.rb
-- spec/timber/probes/rack_http_context_spec.rb
 - spec/timber/probes/rails_rack_logger_spec.rb
+- spec/timber/rack_middlewares/http_context_spec.rb

data/lib/timber/contexts/tags.rb

@@ -1,22 +0,0 @@
-module Timber
-  module Contexts
-    # Adds unnamed tags to the context.
-    #
-    # **Warning:** It is highly recommend that you use custom contexts instead. As they are
-    # more descriptive. This module exists primarily to support the ActiveSupport::TaggedLogging
-    # antipattern.
-    class Tags < Context
-      @keyspace = :tags
-
-      attr_reader :values
-
-      def initialize(attributes)
-        @values = attributes[:values] || raise(ArgumentError.new(":values is required"))
-      end
-
-      def as_json(_options = {})
-        values
-      end
-    end
-  end
-end

data/lib/timber/probes/rack_http_context.rb

@@ -1,51 +0,0 @@
-module Timber
-  module Probes
-    # Reponsible for automatically adding the HTTP context for applications that use `Rack`.
-    class RackHTTPContext < Probe
-      class Middleware
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          request = ::Rack::Request.new(env)
-          context = Contexts::HTTP.new(
-            method: request.request_method,
-            path: request.path,
-            remote_addr: request.ip,
-            request_id: request_id(env)
-          )
-          CurrentContext.with(context) do
-            @app.call(env)
-          end
-        end
-
-        private
-          def request_id(env)
-            env["X-Request-ID"] ||
-              env["X-Request-Id"] ||
-              env["action_dispatch.request_id"]
-          end
-      end
-
-      attr_reader :middleware, :insert_before
-
-      def initialize(middleware, insert_before)
-        if middleware.nil?
-          raise RequirementNotMetError.new("The middleware class attribute is not set. " +
-            "We need a middleware to insert the probe.")
-        end
-        @middleware = middleware
-        @insert_before = insert_before
-      end
-
-      def insert!
-        var_name = :"@_timber_rack_http_inserted"
-        return true if middleware.instance_variable_defined?(var_name) && middleware.instance_variable_get(var_name) == true
-        # Rails uses a proxy :/, so we need to do this instance variable hack
-        middleware.instance_variable_set(var_name, true)
-        middleware.insert_before insert_before, Middleware
-      end
-    end
-  end
-end

data/spec/timber/probes/rack_http_context_spec.rb

@@ -1,50 +0,0 @@
-require "spec_helper"
-
-describe Timber::Probes::RackHTTPContext do
-  describe described_class::Middleware 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] = 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
-
-      Timecop.freeze(time) { example.run }
-
-      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
-        allow_any_instance_of(Timber::Probes::ActionControllerLogSubscriber::LogSubscriber).to receive(:logger).and_return(logger)
-
-        dispatch_rails_request("/rack_http")
-        http_context = Thread.current[:_timber_context][:http]
-
-        expect(http_context).to eq({:method=>"GET", :path=>"/rack_http", :remote_addr=>"123.456.789.10", :request_id=>"unique-request-id-1234"})
-        message = "Processing by RackHttpController#index as HTML @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"controller_call\":{\"controller\":\"RackHttpController\",\"action\":\"index\"}},\"context\":{\"http\":{\"method\":\"GET\",\"path\":\"/rack_http\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}}\nCompleted 200 OK in 0.0ms (Views: 1.0ms) @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"http_response\":{\"status\":200,\"time_ms\":0.0}},\"context\":{\"http\":{\"method\":\"GET\",\"path\":\"/rack_http\",\"remote_addr\":\"123.456.789.10\",\"request_id\":\"unique-request-id-1234\"}}}\n"
-        expect(io.string).to eq(message)
-      end
-    end
-  end
-end