timber 2.6.2 → 3.0.0

data/lib/timber/events/http_request.rb

@@ -1,71 +0,0 @@
-require "timber/event"
-require "timber/util"
-
-module Timber
-  module Events
-    # The HTTP server request event tracks incoming HTTP requests to your HTTP server.
-    # Such as unicorn, webrick, puma, etc.
-    #
-    # @note This event should be installed automatically through integrations,
-    #   such as the {Integrations::ActionController::LogSubscriber} integration.
-    class HTTPRequest < Timber::Event
-      BODY_MAX_BYTES = 8192.freeze
-      HEADERS_JSON_MAX_BYTES = 8192.freeze
-      HEADERS_TO_SANITIZE = ['authorization', 'x-amz-security-token'].freeze
-      HOST_MAX_BYTES = 256.freeze
-      METHOD_MAX_BYTES = 20.freeze
-      PATH_MAX_BYTES = 2048.freeze
-      QUERY_STRING_MAX_BYTES = 2048.freeze
-      REQUEST_ID_MAX_BYTES = 256.freeze
-      SCHEME_MAX_BYTES = 20.freeze
-      SERVICE_NAME_MAX_BYTES = 256.freeze
-
-      attr_reader :body, :content_length, :headers, :host, :method, :path, :port, :query_string,
-        :request_id, :scheme, :service_name
-
-      def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        body_limit = Config.instance.http_body_limit || BODY_MAX_BYTES
-        headers_to_sanitize = HEADERS_TO_SANITIZE + (Config.instance.http_header_filters || [])
-
-        @body = normalizer.fetch(:body, :string, :limit => body_limit)
-        @content_length = normalizer.fetch(:content_length, :integer)
-        @headers = normalizer.fetch(:headers, :hash, :sanitize => headers_to_sanitize)
-        @host = normalizer.fetch(:host, :string, :limit => HOST_MAX_BYTES)
-        @method = normalizer.fetch!(:method, :string, :upcase => true, :limit => METHOD_MAX_BYTES)
-        @path = normalizer.fetch(:path, :string, :limit => PATH_MAX_BYTES)
-        @port = normalizer.fetch(:port, :integer)
-        @query_string = normalizer.fetch(:query_string, :string, :limit => QUERY_STRING_MAX_BYTES)
-        @scheme = normalizer.fetch(:scheme, :string, :limit => SCHEME_MAX_BYTES)
-        @request_id = normalizer.fetch(:request_id, :string, :limit => REQUEST_ID_MAX_BYTES)
-        @service_name = normalizer.fetch(:service_name, :string, :limit => SERVICE_NAME_MAX_BYTES)
-      end
-
-      def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:body, body)
-          h.add(:content_length, content_length)
-          h.add(:headers_json, headers, :json_encode => true, :limit => HEADERS_JSON_MAX_BYTES)
-          h.add(:host, host)
-          h.add(:method, method)
-          h.add(:path, path)
-          h.add(:port, port)
-          h.add(:query_string, query_string)
-          h.add(:request_id, request_id)
-          h.add(:scheme, scheme)
-          h.add(:service_name, service_name)
-        end
-      end
-      alias to_h to_hash
-
-      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
-      def as_json(_options = {})
-        {:http_request => to_hash}
-      end
-
-      def message
-        'Started %s "%s"' % [method, path]
-      end
-    end
-  end
-end

data/lib/timber/events/http_response.rb

@@ -1,81 +0,0 @@
-require "timber/event"
-require "timber/util"
-
-module Timber
-  module Events
-    # The HTTP server response event tracks outgoing HTTP responses that you send
-    # to clients.
-    #
-    # @note This event should be installed automatically through integrations,
-    #   such as the {Integrations::ActionController::LogSubscriber} integration.
-    class HTTPResponse < Timber::Event
-      BODY_MAX_BYTES = 8192.freeze
-      HEADERS_JSON_MAX_BYTES = 256.freeze
-      HEADERS_TO_SANITIZE = ['authorization', 'x-amz-security-token'].freeze
-      REQUEST_ID_MAX_BYTES = 256.freeze
-      SERVICE_NAME_MAX_BYTES = 256.freeze
-
-      attr_reader :body, :content_length, :headers, :http_context, :request_id, :service_name,
-        :status, :time_ms
-
-      def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        body_limit = Config.instance.http_body_limit || BODY_MAX_BYTES
-        headers_to_sanitize = HEADERS_TO_SANITIZE + (Config.instance.http_header_filters || [])
-
-        @body = normalizer.fetch(:body, :string, :limit => body_limit)
-        @content_length = normalizer.fetch(:content_length, :integer)
-        @headers = normalizer.fetch(:headers, :hash, :sanitize => headers_to_sanitize)
-        @http_context = attributes[:http_context]
-        @request_id = normalizer.fetch(:request_id, :string, :limit => REQUEST_ID_MAX_BYTES)
-        @service_name = normalizer.fetch(:service_name, :string, :limit => SERVICE_NAME_MAX_BYTES)
-        @status = normalizer.fetch!(:status, :integer)
-        @time_ms = normalizer.fetch!(:time_ms, :float, :precision => 6)
-      end
-
-      def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:body, body)
-          h.add(:content_length, content_length)
-          h.add(:headers_json, headers, :json_encode => true, :limit => HEADERS_JSON_MAX_BYTES)
-          h.add(:request_id, request_id)
-          h.add(:service_name, service_name)
-          h.add(:status, status)
-          h.add(:time_ms, time_ms)
-        end
-      end
-      alias to_h to_hash
-
-      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
-      def as_json(_options = {})
-        {:http_response => to_hash}
-      end
-
-      # Returns the human readable log message for this event.
-      def message
-        if http_context
-          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
-          message = "Completed #{status} #{status_description} "
-
-          if content_length
-            message << ", #{content_length} bytes, "
-          end
-
-          message << "in #{time_ms}ms"
-        end
-      end
-
-      def status_description
-        Rack::Utils::HTTP_STATUS_CODES[status]
-      end
-    end
-  end
-end

data/lib/timber/frameworks.rb

@@ -1,19 +0,0 @@
-require "logger"
-
-# Attempt to require Rails. We can not list it as a gem
-# dependency because we want to support multiple frameworks.
-begin
-  require "rails"
-rescue LoadError
-end
-
-if defined?(::Rails) && defined?(::Rails::Railtie)
-  require "timber/frameworks/rails"
-end
-
-module Timber
-  # Namespace for installing Timber into frameworks
-  # @private
-  module Frameworks
-  end
-end

data/lib/timber/frameworks/rails.rb

@@ -1,27 +0,0 @@
-module Timber
-  module Frameworks
-    # Module for Rails specific code, such as the Railtie and any methods that assist
-    # with Rails setup.
-    module Rails
-      # Installs Timber into your Rails app automatically.
-      class Railtie < ::Rails::Railtie
-        config.timber = Config.instance
-
-        config.before_initialize do
-          Timber::Config.instance.logger = Proc.new { ::Rails.logger }
-        end
-
-        # Must be loaded after initializers so that we respect any Timber configuration set
-        initializer(:timber, before: :build_middleware_stack, after: :load_config_initializers) do
-          Integrations.integrate!
-
-          # Install the Rack middlewares so that we capture structured data instead of
-          # raw text logs.
-          Integrations::Rack.middlewares.collect do |middleware_class|
-            config.app_middleware.use middleware_class
-          end
-        end
-      end
-    end
-  end
-end

data/lib/timber/integrations.rb

@@ -1,29 +0,0 @@
-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"
-
-module Timber
-  # 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.integrate!
-      ActionDispatch.integrate!
-      ActionView.integrate!
-      ActiveRecord.integrate!
-      Rails.integrate!
-    end
-  end
-end

data/lib/timber/integrations/action_controller.rb

@@ -1,18 +0,0 @@
-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,27 +0,0 @@
-require "timber/integrator"
-
-module Timber
-  module Integrations
-    module ActionController
-      # Responsible for removing the default ActionController::LogSubscriber and installing
-      # the TimberLogSubscriber
-      #
-      # @private
-      class LogSubscriber < Integrator
-        def initialize
-          require "action_controller/log_subscriber"
-          require "timber/integrations/action_controller/log_subscriber/timber_log_subscriber"
-        rescue LoadError => e
-          raise RequirementNotMetError.new(e.message)
-        end
-
-        def integrate!
-          return true if Util::ActiveSupportLogSubscriber.subscribed?(:action_controller, TimberLogSubscriber)
-
-          Util::ActiveSupportLogSubscriber.unsubscribe!(:action_controller, ::ActionController::LogSubscriber)
-          TimberLogSubscriber.attach_to(:action_controller)
-        end
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-module Timber
-  module Integrations
-    module ActionController
-      class LogSubscriber < Integrator
-        # The log subscriber that replaces the default `ActionController::LogSubscriber`.
-        # The intent of this subscriber is to, as transparently as possible, properly
-        # track events that are being logged here. This LogSubscriber will never change
-        # default behavior / log messages.
-        #
-        # @private
-        class TimberLogSubscriber < ::ActionController::LogSubscriber
-          def start_processing(event)
-            return true if silence?
-
-            info do
-              payload = event.payload
-              params  = payload[:params].except(*INTERNAL_PARAMS)
-              format  = extract_format(payload)
-              format  = format.to_s.upcase if format.is_a?(Symbol)
-
-              Events::ControllerCall.new(
-                controller: payload[:controller],
-                action: payload[:action],
-                format: format,
-                params: params
-              )
-            end
-          end
-
-          private
-            def extract_format(payload)
-              if payload.key?(:format)
-                payload[:format] # rails > 4.X
-              elsif payload.key?(:formats)
-                payload[:formats].first # rails 3.X
-              end
-            end
-
-            def silence?
-              ActionController.silence?
-            end
-        end
-      end
-    end
-  end
-end

data/lib/timber/integrations/action_dispatch.rb

@@ -1,23 +0,0 @@
-require "timber/integration"
-require "timber/integrations/rack/error_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::ErrorEvent.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,53 +0,0 @@
-require "timber/integrator"
-
-module Timber
-  module Integrations
-    module ActionDispatch
-      # Reponsible for disabled logging in the ActionDispatch::DebugExceptions
-      # Rack middleware. We cannot simply remove the middleware because it is
-      # coupled with displaying an exception debug screen if debug exceptions is enabled.
-      #
-      # @private
-      class DebugExceptions < Integrator
-
-        # Patch for disabling logging
-        #
-        # @private
-        module InstanceMethods
-          def self.included(klass)
-            klass.class_eval do
-              private
-                def logger(*args)
-                  nil
-                end
-            end
-          end
-        end
-
-        def initialize
-          begin
-            # Rails >= 3.1
-            require "action_dispatch/middleware/debug_exceptions"
-          rescue LoadError
-            # Rails < 3.1
-            require "action_dispatch/middleware/show_exceptions"
-          end
-        rescue LoadError => e
-          raise RequirementNotMetError.new(e.message)
-        end
-
-        def integrate!
-          if defined?(::ActionDispatch::DebugExceptions) && !::ActionDispatch::DebugExceptions.include?(InstanceMethods)
-            ::ActionDispatch::DebugExceptions.send(:include, InstanceMethods)
-          end
-
-          if defined?(::ActionDispatch::ShowExceptions) && !::ActionDispatch::ShowExceptions.include?(InstanceMethods)
-            ::ActionDispatch::ShowExceptions.send(:include, InstanceMethods)
-          end
-
-          true
-        end
-      end
-    end
-  end
-end

data/lib/timber/integrations/action_view.rb

@@ -1,18 +0,0 @@
-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,27 +0,0 @@
-require "timber/integrator"
-
-module Timber
-  module Integrations
-    module ActionView
-      # Reponsible for uninstalling the default `ActionView::LogSubscriber` and installing
-      # the TimberLogSubscriber.
-      #
-      # @private
-      class LogSubscriber < Integrator
-        def initialize
-          require "action_view/log_subscriber"
-          require "timber/integrations/action_view/log_subscriber/timber_log_subscriber"
-        rescue LoadError => e
-          raise RequirementNotMetError.new(e.message)
-        end
-
-        def integrate!
-          return true if Util::ActiveSupportLogSubscriber.subscribed?(:action_view, TimberLogSubscriber)
-
-          Util::ActiveSupportLogSubscriber.unsubscribe!(:action_view, ::ActionView::LogSubscriber)
-          TimberLogSubscriber.attach_to(:action_view)
-        end
-      end
-    end
-  end
-end