timber 2.6.2 → 3.0.0

data/lib/timber.rb

@@ -1,21 +1,21 @@
 # Base (must come first, order matters)
 require "timber/version"
-require "timber/overrides"
 require "timber/config"
 require "timber/util"
 
+# Load frameworks
+
 # Other (sorted alphabetically)
 require "timber/contexts"
 require "timber/current_context"
 require "timber/events"
+require "timber/integration"
 require "timber/log_devices"
 require "timber/log_entry"
 require "timber/logger"
-require "timber/integrations"
 require "timber/timer"
-
-# Load frameworks
-require "timber/frameworks"
+require "timber/integrator"
+require "timber/integration"
 
 module Timber
   # Access the main configuration object. Please see {{Timber::Config}} for more details.
@@ -33,4 +33,4 @@ module Timber
   def self.with_context(context, &block)
     CurrentContext.with(context, &block)
   end
-end
+end

data/lib/timber/config.rb

@@ -1,8 +1,6 @@
 require "logger"
 require "singleton"
 
-require "timber/config/integrations"
-
 module Timber
   # Singleton class for reading and setting Timber configuration.
   #
@@ -25,7 +23,6 @@ module Timber
       end
     end
 
-    DEFAULT_HTTP_BODY_LIMIT = 2048.freeze
     DEVELOPMENT_NAME = "development".freeze
     PRODUCTION_NAME = "production".freeze
     STAGING_NAME = "staging".freeze
@@ -35,11 +32,6 @@ module Timber
 
     attr_writer :http_body_limit
 
-    # @private
-    def initialize
-      @http_body_limit = DEFAULT_HTTP_BODY_LIMIT
-    end
-
     # Convenience method for logging debug statements to the debug logger
     # set in this class.
     # @private
@@ -112,39 +104,6 @@ module Timber
       @environment ||= ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
     end
 
-    # This is a list of header keys that should be filtered. Note, all headers are
-    # normalized to down-case. So please _only_ pass down-cased headers.
-    #
-    # @example Rails
-    #   # config/environments/production.rb
-    #   config.timber.header_filter_headers += ['api-key']
-    def http_header_filters=(value)
-      @http_header_filters = value
-    end
-
-    # Accessor method for {#http_header_filters=}
-    def http_header_filters
-      @http_header_filters ||= []
-    end
-
-    # Truncates captured HTTP bodies to this specified limit. The default is `2048`.
-    # If you want to capture more data, you can raise this to a maximum of `8192`,
-    # or lower this to be more efficient with data. `2048` characters should give you a good
-    # idea of the body content.
-    #
-    # @example Rails
-    #   config.timber.http_body_limit = 2048
-    # @example Everything else
-    #   Timber::Config.instance.http_body_limit = 2048
-    def http_body_limit=(value)
-      @http_body_limit = value
-    end
-
-    # Accessor method for {#http_body_limit=}
-    def http_body_limit
-      @http_body_limit
-    end
-
     # Convenience method for accessing the various `Timber::Integrations::*` class
     # settings. These provides settings for enabling, disabled, and silencing integrations.
     # See {Integrations} for a full list of available methods.
@@ -152,47 +111,6 @@ module Timber
       Integrations
     end
 
-    # A convenience method that automatically sets Timber's configuration to closely match
-    # the behavior of the ruby lograge library. This makes it easier when transitioning
-    # from lograge.
-    #
-    # It turns this:
-    #
-    #   Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
-    #   Processing by HomeController#index as HTML
-    #     Rendered text template within layouts/application (0.0ms)
-    #     Rendered layouts/_assets.html.erb (2.0ms)
-    #     Rendered layouts/_top.html.erb (2.6ms)
-    #     Rendered layouts/_about.html.erb (0.3ms)
-    #     Rendered layouts/_google_analytics.html.erb (0.4ms)
-    #   Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
-    #
-    # Into this:
-    #
-    #   Get "/" sent 200 OK in 79ms @metadata {...}
-    #
-    # In other words it:
-    #
-    # 1. Silences ActiveRecord SQL query logs.
-    # 2. Silences ActiveView template rendering logs.
-    # 3. Silences ActionController controller call logs.
-    # 4. Collapses HTTP request and response logs into a single event.
-    #
-    # Notice also that is is not exactly like lograge. This is intentional. Lograge has
-    # a number of downsides:
-    #
-    # 1. The attribute names (`method`, `format`, `status`, `db`, etc) are too generalized and vague.
-    #    This makes it _very_ likely that it will clash with other structured data you're
-    #    logging.
-    # 2. It doesn't support context making it near impossible to view in-app logs generated for
-    #    the same request.
-    def logrageify!
-      integrations.action_controller.silence = true
-      integrations.action_view.silence = true
-      integrations.active_record.silence = true
-      integrations.rack.http_events.collapse_into_single_event = true
-    end
-
     # This is the _main_ logger Timber writes to. All of the Timber integrations write to
     # this logger instance. It should be set to your global logger. For Rails, this is set
     # automatically to `Rails.logger`, you should not have to set this.
@@ -233,4 +151,4 @@ module Timber
       environment == STAGING_NAME
     end
   end
-end
+end

data/lib/timber/config/integrations.rb

@@ -1,9 +1,3 @@
-require "timber/config/integrations/rack"
-require "timber/integrations/action_controller"
-require "timber/integrations/action_view"
-require "timber/integrations/active_record"
-require "timber/integrations/rack"
-
 module Timber
   class Config
     # Convenience module for accessing the various `Timber::Integrations::*` classes
@@ -18,46 +12,6 @@ module Timber
     #     config.integrations.active_record.silence = true
     module Integrations
       extend self
-
-      # Convenience method for accessing the {Timber::Integrations::ActionController} class
-      # specific configuration.
-      #
-      # @example
-      #   config = Timber::Config.instance
-      #   config.integrations.action_controller.silence = true
-      def action_controller
-        Timber::Integrations::ActionController
-      end
-
-      # Convenience method for accessing the {Timber::Integrations::ActionView} class
-      # specific configuration.
-      #
-      # @example
-      #   config = Timber::Config.instance
-      #   config.integrations.action_view.silence = true
-      def action_view
-        Timber::Integrations::ActionView
-      end
-
-      # Convenience method for accessing the {Timber::Integrations::ActiveRecord} class
-      # specific configuration.
-      #
-      # @example
-      #   config = Timber::Config.instance
-      #   config.integrations.active_record.silence = true
-      def active_record
-        Timber::Integrations::ActiveRecord
-      end
-
-      # Convenience method for accessing the various `Timber::Integrations::Rack::*`
-      # classes. See {Rack} for a list of methods available.
-      #
-      # @example
-      #   config = Timber::Config.instance
-      #   config.integrations.rack.http_events.enabled = true
-      def rack
-        Rack
-      end
     end
   end
-end
+end

data/lib/timber/context.rb

@@ -2,29 +2,8 @@ module Timber
   # Base class for all `Timber::Contexts::*` classes.
   # @private
   class Context
-    class << self
-      # The keyspace is the key used when storing the context.
-      # For example:
-      #
-      #     {:build => {:version => "1.0.0"}}
-      #
-      # The keyspace in the above context is `:build`. This is required
-      # because it prevents key name conflicts. Without the keyspace
-      # it very possible another context type might also have a `:version`
-      # attribute.
-      def keyspace
-        @keyspace || raise(NotImplementedError.new)
-      end
-    end
-
-    # Returns a simple structure sufficient for encoding. We use
-    # `as_json` as the name since this is a ruby pattern.
-    def as_json(options = {})
-      raise NotImplementedError.new
-    end
-
-    def keyspace
-      self.class.keyspace
+    def to_hash
+      raise(NotImplementedError.new)
     end
   end
-end
+end

data/lib/timber/contexts.rb

@@ -1,6 +1,4 @@
-require "timber/contexts/custom"
 require "timber/contexts/http"
-require "timber/contexts/organization"
 require "timber/contexts/release"
 require "timber/contexts/runtime"
 require "timber/contexts/session"
@@ -8,33 +6,7 @@ require "timber/contexts/system"
 require "timber/contexts/user"
 
 module Timber
-  # Namespace for all Timber supported Contexts.
+  # @private
   module Contexts
-    # Protocol for casting objects into a {Timber::Context}.
-    #
-    # @example Casting a hash
-    #   Timber::Contexts.build(deploy: {version: "1.0.0"})
-    def self.build(obj)
-      if obj.is_a?(::Timber::Context)
-        obj
-      elsif obj.respond_to?(:to_timber_context)
-        obj.to_timber_context
-      elsif obj.is_a?(Hash) && obj.length == 1
-        type = obj.keys.first
-        data = obj.values.first
-
-        Contexts::Custom.new(
-          type: type,
-          data: data
-        )
-      elsif obj.is_a?(Struct) && obj.respond_to?(:type)
-        Contexts::Custom.new(
-          type: obj.type,
-          data: obj.respond_to?(:to_h) ? obj.to_h : Timber::Util::Struct.to_hash(obj) # ruby 1.9.3 does not have to_h
-        )
-      else
-        nil
-      end
-    end
   end
-end
+end

data/lib/timber/contexts/http.rb

@@ -2,50 +2,30 @@ require "timber/context"
 
 module Timber
   module Contexts
-    # The HTTP context adds data about the current HTTP request being processed to your logs.
-    # This allows you to tail and filter by this data. A very useful piece of data this
-    # captures is the request ID. This gives you the ability to trace requests and view logs
-    # for a specific request only. For example, say you've searched your logs and found the
-    # specific line you are looking for, but it lacks context. With Timber you can simply
-    # click the request ID and "zoom out" to view all logs for that request. This gives you
-    # complete picture of how the log line in questio was generated.
-    #
-    # @note This context should be installed automatically through the,
-    #   {Intregrations::Rack::HTTPContext} Rack middleware.
+    # @private
     class HTTP < Context
-      HOST_MAX_BYTES = 256.freeze
-      METHOD_MAX_BYTES = 20.freeze
-      PATH_MAX_BYTES = 2048.freeze
-      REMOTE_ADDR_MAX_BYTES = 256.freeze
-      REQUEST_ID_MAX_BYTES = 256.freeze
-
-      @keyspace = :http
-
       attr_reader :host, :method, :path, :remote_addr, :request_id
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @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)
-        @remote_addr = normalizer.fetch(:remote_addr, :string, :limit => REMOTE_ADDR_MAX_BYTES)
-        @request_id = normalizer.fetch(:request_id, :string, :limit => REQUEST_ID_MAX_BYTES)
+        @host = attributes[:host]
+        @method = attributes[:method]
+        @path = attributes[:path]
+        @remote_addr = attributes[:remote_addr]
+        @request_id = attributes[:request_id]
       end
 
       # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:host, host)
-          h.add(:method, method)
-          h.add(:path, path)
-          h.add(:remote_addr, remote_addr)
-          h.add(:request_id, request_id)
-        end
-      end
-
-      def as_json(_options = {})
-        to_hash
+        @to_hash ||= {
+          http: Util::NonNilHashBuilder.build do |h|
+            h.add(:host, host)
+            h.add(:method, method)
+            h.add(:path, path)
+            h.add(:remote_addr, remote_addr)
+            h.add(:request_id, request_id)
+          end
+        }
       end
     end
   end
-end
+end

data/lib/timber/contexts/release.rb

@@ -4,16 +4,8 @@ require "timber/util"
 
 module Timber
   module Contexts
-    # The release context tracks application releases / versions / deploys.
-    #
-    # @note To automatically set this context, see {.from_env}.
+    # @private
     class Release < Context
-      COMMIT_HASH_MAX_BYTES = 256.freeze
-      CREATED_AT_MAX_BYTES = 256.freeze
-      VERSION_MAX_BYTES = 256.freeze
-
-      @keyspace = :release
-
       class << self
         # Builds a release context based on environment variables. Simply add the
         # `RELEASE_COMMIT`, `RELEASE_CREATED_AT`, or the `RELEASE_VERSION` env vars
@@ -40,24 +32,21 @@ module Timber
       attr_reader :commit_hash, :created_at, :version
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @commit_hash = normalizer.fetch(:commit_hash, :string, :limit => COMMIT_HASH_MAX_BYTES)
-        @created_at = normalizer.fetch(:created_at, :string, :limit => CREATED_AT_MAX_BYTES)
-        @version = normalizer.fetch(:version, :string, :limit => VERSION_MAX_BYTES)
+        @commit_hash = attributes[:commit_hash]
+        @created_at = attributes[:created_at]
+        @version = attributes[:version]
       end
 
       # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:commit_hash, commit_hash)
-          h.add(:created_at, created_at)
-          h.add(:version, version)
-        end
-      end
-
-      def as_json(_options = {})
-        to_hash
+        @to_hash ||= {
+          release: Util::NonNilHashBuilder.build do |h|
+            h.add(:commit_hash, commit_hash)
+            h.add(:created_at, created_at)
+            h.add(:version, version)
+          end
+        }
       end
     end
   end
-end
+end

data/lib/timber/contexts/runtime.rb

@@ -2,49 +2,22 @@ require "timber/context"
 
 module Timber
   module Contexts
-    # The runtime context adds current runtime data to your logs, such as the file, line number,
-    # class or module name, etc. This makes it easy to tail and search your logs by their
-    # origin in your code. For example, if you are debugging a specific class, you can narrow
-    # by that class and see only it's logs.
+    # @private
     class Runtime < Context
-      APPLICATION_MAX_BYTES = 256.freeze
-      CLASS_NAME_MAX_BYTES = 256.freeze
-      FILE_MAX_BYTES = 1024.freeze
-      FUNCTION_MAX_BYTES = 256.freeze
-      MODULE_NAME_MAX_BYTES = 256.freeze
-      VM_PID_MAX_BYTES = 256.freeze
-
-      @keyspace = :runtime
-
-      attr_reader :application, :class_name, :file, :function, :line, :module_name, :vm_pid
+      attr_reader :thread_id
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @application = normalizer.fetch(:application, :string, :limit => APPLICATION_MAX_BYTES)
-        @class_name = normalizer.fetch(:class_name, :string, :limit => CLASS_NAME_MAX_BYTES)
-        @file = normalizer.fetch(:file, :string, :limit => FILE_MAX_BYTES)
-        @function = normalizer.fetch(:function, :string, :limit => FUNCTION_MAX_BYTES)
-        @line = normalizer.fetch(:line, :integer)
-        @module_name = normalizer.fetch(:module_name, :string, :limit => MODULE_NAME_MAX_BYTES)
-        @vm_pid = normalizer.fetch(:vm_pid, :string, :limit => VM_PID_MAX_BYTES)
+        @thread_id = attributes[:thread_id]
       end
 
       # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:application, application)
-          h.add(:class_name, class_name)
-          h.add(:file, file)
-          h.add(:function, function)
-          h.add(:line, line)
-          h.add(:module_name, module_name)
-          h.add(:vm_pid, vm_pid)
-        end
-      end
-
-      def as_json(_options = {})
-        to_hash
+        @to_hash ||= {
+          runtime: Util::NonNilHashBuilder.build do |h|
+            h.add(:thread_id, thread_id)
+          end
+        }
       end
     end
   end
-end
+end