timber 2.0.24 → 2.1.0.rc1

data/lib/timber/events/controller_call.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The controller call event tracks controller invocations. For example, this line in Rails:
@@ -23,6 +26,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:controller_call => to_hash}
       end

data/lib/timber/events/custom.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # Allows for custom events that aren't covered elsewhere.
@@ -22,7 +25,15 @@ module Timber
       def initialize(attributes)
         @type = attributes[:type] || raise(ArgumentError.new(":type is required"))
         @message = attributes[:message] || raise(ArgumentError.new(":message is required"))
-        @data = attributes[:data]
+
+        data = attributes[:data]
+
+        if data.is_a?(Hash) && data[:time_ms].is_a?(Time)
+          data[:time_ms] = Timer.duration_ms(data[:time_ms])
+          @message << " in #{data[:time_ms]}ms"
+        end
+
+        @data = data
       end
 
       def to_hash
@@ -30,13 +41,10 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:custom => to_hash}
       end
-
-      def to_json(options = {})
-        as_json().to_json(options)
-      end
     end
   end
 end

data/lib/timber/events/exception.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The exception event is used to track exceptions.
@@ -25,6 +28,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:exception => to_hash}
       end

data/lib/timber/events/http_client_request.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The HTTP client request event tracks *outgoing* HTTP requests giving you structured insight
@@ -30,6 +33,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:http_client_request => to_hash}
       end

data/lib/timber/events/http_client_response.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The HTTP client response event tracks responses for *outgoing* HTTP *requests*.
@@ -25,6 +28,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:http_client_response => to_hash}
       end

data/lib/timber/events/http_server_request.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The HTTP server request event tracks incoming HTTP requests to your HTTP server.
@@ -10,6 +13,7 @@ module Timber
         :scheme
 
       def initialize(attributes)
+        @body = attributes[:body] && Util::HTTPEvent.normalize_body(attributes[:body])
         @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"))
@@ -26,6 +30,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:http_server_request => to_hash}
       end

data/lib/timber/events/http_server_response.rb

@@ -1,3 +1,6 @@
+require "timber/event"
+require "timber/util"
+
 module Timber
   module Events
     # The HTTP server response event tracks outgoing HTTP responses that you send
@@ -6,10 +9,12 @@ module Timber
     # @note This event should be installed automatically through integrations,
     #   such as the {Integrations::ActionController::LogSubscriber} integration.
     class HTTPServerResponse < Timber::Event
-      attr_reader :headers, :request_id, :status, :time_ms
+      attr_reader :body, :headers, :http_context, :request_id, :status, :time_ms
 
       def initialize(attributes)
+        @body = attributes[:body] && Util::HTTPEvent.normalize_body(attributes[:body])
         @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
+        @http_context = attributes[:http_context]
         @request_id = attributes[:request_id]
         @status = attributes[:status] || raise(ArgumentError.new(":status is required"))
         @time_ms = attributes[:time_ms] || raise(ArgumentError.new(":time_ms is required"))
@@ -17,16 +22,23 @@ module Timber
       end
 
       def to_hash
-        {headers: headers, request_id: request_id, status: status, time_ms: time_ms}
+        {body: body, headers: headers, request_id: request_id, status: status, time_ms: time_ms}
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:http_server_response => to_hash}
       end
 
+      # Returns the human readable log message for this event.
       def message
-        "Completed #{status} #{status_description} in #{time_ms}ms"
+        if http_context
+          "#{http_context[:method]} #{http_context[:path]} sent #{status} #{status_description} " \
+            "in #{time_ms}ms"
+        else
+          "Completed #{status} #{status_description} in #{time_ms}ms"
+        end
       end
 
       def status_description

data/lib/timber/events/sql_query.rb

@@ -1,3 +1,5 @@
+require "timber/event"
+
 module Timber
   module Events
     # The SQL query event tracks sql queries to your database.
@@ -19,6 +21,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:sql_query => to_hash}
       end

data/lib/timber/events/template_render.rb

@@ -1,3 +1,5 @@
+require "timber/event"
+
 module Timber
   module Events
     # The template render event track template renderings and their performance.
@@ -19,6 +21,7 @@ module Timber
       end
       alias to_h to_hash
 
+      # Builds a hash representation of containing simply objects, suitable for serialization.
       def as_json(_options = {})
         {:template_render => to_hash}
       end

data/lib/timber/integration.rb

@@ -0,0 +1,40 @@
+module Timber
+  # An integration represent an integration for an entire library. For example, `Rack`.
+  # While the Timber `Rack` integration is comprised of multiple middlewares, the
+  # `Timber::Integrations::Rack` module is an entire integration that extends this module.
+  module Integration
+    # Easily sisable entire library integrations. This is like removing the code from
+    # Timber. It will not touch this library and the library will function as it would
+    # without Timber.
+    #
+    # @example
+    #   Timber::Integrations::ActiveRecord.enabled = false
+    def enabled=(value)
+      @enabled = value
+    end
+
+    # Accessor method for {#enabled=}
+    def enabled?
+      @enabled != false
+    end
+
+    # Silences a library's logs. This ensures that logs are not generated at all
+    # from this library.
+    #
+    # @example
+    #   Timber::Integrations::ActiveRecord.silence = true
+    def silence=(value)
+      @silence = value
+    end
+
+    # Accessor method for {#silence=}
+    def silence?
+      @silence == true
+    end
+
+    # Abstract method that each integration must implement.
+    def integrate!
+      raise NotImplementedError.new
+    end
+  end
+end

data/lib/timber/integrations.rb

@@ -1,22 +1,29 @@
-require "timber/integrations/action_controller/log_subscriber"
-require "timber/integrations/action_dispatch/debug_exceptions"
-require "timber/integrations/action_view/log_subscriber"
-require "timber/integrations/active_record/log_subscriber"
-require "timber/integrations/active_support/tagged_logging"
+require "timber/integrations/action_controller"
+require "timber/integrations/action_dispatch"
+require "timber/integrations/action_view"
+require "timber/integrations/active_record"
 require "timber/integrations/rack"
-require "timber/integrations/rails/rack_logger"
+require "timber/integrations/rails"
 
 module Timber
-  # Namespace for all integrations.
-  # @private
+  # Namespace for all integrations. Each integration provides it's own settings.
+  # And all integrations can be disabled with the {.enabled=} class method.
   module Integrations
+    # Disable / enable _all_ integrations with one setting.
+    def self.enabled=(value)
+      ActionController.enabled = value
+      ActionView.enabled = value
+      ActiveRecord.enabled = value
+      Rack.enabled = value
+    end
+
+    # Integrates all enabled integrations in one call.
     def self.integrate!
-      ActionController::LogSubscriber.integrate!
-      ActionDispatch::DebugExceptions.integrate!
-      ActionView::LogSubscriber.integrate!
-      ActiveRecord::LogSubscriber.integrate!
-      ActiveSupport::TaggedLogging.integrate!
-      Rails::RackLogger.integrate!
+      ActionController.integrate!
+      ActionDispatch.integrate!
+      ActionView.integrate!
+      ActiveRecord.integrate!
+      Rails.integrate!
     end
   end
 end

data/lib/timber/integrations/action_controller.rb

@@ -0,0 +1,18 @@
+require "timber/integration"
+require "timber/integrations/action_controller/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionController integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActionController
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end

data/lib/timber/integrations/action_controller/log_subscriber.rb

@@ -1,3 +1,5 @@
+require "timber/integrator"
+
 module Timber
   module Integrations
     module ActionController

data/lib/timber/integrations/action_controller/log_subscriber/timber_log_subscriber.rb

@@ -10,6 +10,8 @@ module Timber
         # @private
         class TimberLogSubscriber < ::ActionController::LogSubscriber
           def start_processing(event)
+            return true if silence?
+
             info do
               payload = event.payload
               params  = payload[:params].except(*INTERNAL_PARAMS)
@@ -33,6 +35,10 @@ module Timber
                 payload[:formats].first # rails 3.X
               end
             end
+
+            def silence?
+              ActionController.silence?
+            end
         end
       end
     end

data/lib/timber/integrations/action_dispatch.rb

@@ -0,0 +1,23 @@
+require "timber/integration"
+require "timber/integrations/rack/exception_event"
+require "timber/integrations/action_dispatch/debug_exceptions"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionDispatch integrations. This module does *not*
+    # extend {Integration} because it's dependent on {Rack::ExceptionEvent}. This
+    # module simply disables the exception tracking middleware so that our middleware
+    # works as expected.
+    module ActionDispatch
+      def self.enabled?
+        Rack::ExceptionEvent.enabled?
+      end
+
+      def self.integrate!
+        return false if !enabled?
+
+        DebugExceptions.integrate!
+      end
+    end
+  end
+end

data/lib/timber/integrations/action_dispatch/debug_exceptions.rb

@@ -1,3 +1,5 @@
+require "timber/integrator"
+
 module Timber
   module Integrations
     module ActionDispatch

data/lib/timber/integrations/action_view.rb

@@ -0,0 +1,18 @@
+require "timber/integration"
+require "timber/integrations/action_view/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionView integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActionView
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end

data/lib/timber/integrations/action_view/log_subscriber.rb

@@ -1,3 +1,5 @@
+require "timber/integrator"
+
 module Timber
   module Integrations
     module ActionView

data/lib/timber/integrations/action_view/log_subscriber/timber_log_subscriber.rb

@@ -10,6 +10,8 @@ module Timber
         # @private
         class TimberLogSubscriber < ::ActionView::LogSubscriber
           def render_template(event)
+            return true if silence?
+
             info do
               full_name = from_rails_root(event.payload[:identifier])
               message = "  Rendered #{full_name}"
@@ -25,6 +27,8 @@ module Timber
           end
 
           def render_partial(event)
+            return true if silence?
+
             info do
               full_name = from_rails_root(event.payload[:identifier])
               message = "  Rendered #{full_name}"
@@ -41,6 +45,8 @@ module Timber
           end
 
           def render_collection(event)
+            return true if silence?
+
             if respond_to?(:render_count, true)
               info do
                 identifier = event.payload[:identifier] || "templates"
@@ -66,6 +72,10 @@ module Timber
               # rendering a template. If you disagree, please feel free to open a PR and we
               # can make this an option.
             end
+
+            def silence?
+              ActionView.silence?
+            end
         end
       end
     end

data/lib/timber/integrations/active_record.rb

@@ -0,0 +1,18 @@
+require "timber/integration"
+require "timber/integrations/active_record/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActiveRecord integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActiveRecord
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end