timber 1.0.13 → 1.1.0

data/lib/timber.rb

@@ -17,6 +17,7 @@ require "timber/log_devices"
 require "timber/log_entry"
 require "timber/logger"
 require "timber/probes"
+require "timber/rack_middlewares"
 
 # Load frameworks
 require "timber/frameworks"

data/lib/timber/context.rb

@@ -17,7 +17,7 @@ module Timber
     end
 
     def to_json(options = {})
-      Util::Hash.compact(as_json).to_json(options)
+      as_json.to_json(options)
     end
 
     def to_msgpack(*args)

data/lib/timber/contexts.rb

@@ -1,11 +1,38 @@
 require "timber/contexts/custom"
 require "timber/contexts/http"
 require "timber/contexts/organization"
-require "timber/contexts/tags"
+require "timber/contexts/runtime"
+require "timber/contexts/system"
 require "timber/contexts/user"
 
 module Timber
-  # @private
+  # Namespace for all Timber supported Contexts.
   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

data/lib/timber/contexts/runtime.rb

@@ -0,0 +1,24 @@
+module Timber
+  module Contexts
+    # Tracks OS level process information, such as the process ID.
+    class Runtime < Context
+      @keyspace = :runtime
+
+      attr_reader :application, :class_name, :file, :function, :line, :module_name
+
+      def initialize(attributes)
+        @application = attributes[:application]
+        @class_name = attributes[:class_name]
+        @file = attributes[:file]
+        @function = attributes[:function]
+        @line = attributes[:line]
+        @module_name = attributes[:module_name]
+      end
+
+      def as_json(_options = {})
+        {application: application, class_name: class_name, file: file, function: function,
+          line: line, module_name: module_name}
+      end
+    end
+  end
+end

data/lib/timber/contexts/system.rb

@@ -0,0 +1,19 @@
+module Timber
+  module Contexts
+    # Tracks OS level process information, such as the process ID.
+    class System < Context
+      @keyspace = :system
+
+      attr_reader :pid
+
+      def initialize(attributes)
+        @pid = attributes[:pid] || raise(ArgumentError.new(":pid is required"))
+        @pid = @pid.to_s
+      end
+
+      def as_json(_options = {})
+        {pid: pid}
+      end
+    end
+  end
+end

data/lib/timber/current_context.rb

@@ -38,9 +38,17 @@ module Timber
     # @note Because context is included with every log line, it is recommended that you limit this
     #   to only neccessary data.
     #
-    # @example Adding a custom context
-    #   custom_context = Timber::Contexts::Custom.new(type: :organization, data: %{id: 1, name: "Timber"})
-    #   Timber::CurrentContext.with(custom_context) do
+    # @example Adding a custom context with a map
+    #   Timber::CurrentContext.with({build: {version: "1.0.0"}}) do
+    #     # ... anything logged here will include the context ...
+    #   end
+    #
+    # @example Adding a custom context with a struct
+    #   BuildContext = Struct.new(:version) do
+    #     def type; :build; end
+    #    end
+    #    build_context = BuildContext.new("1.0.0")
+    #    Timber::CurrentContext.with(build_context) do
     #     # ... anything logged here will include the context ...
     #   end
     #   # Be sure to checkout Timber::Contexts! These are officially supported and many of these
@@ -67,8 +75,9 @@ module Timber
     #
     # @note Because context is included with every log line, it is recommended that you limit this
     #   to only neccessary data.
-    def add(*contexts)
-      contexts.each do |context|
+    def add(*objects)
+      objects.each do |object|
+        context = Contexts.build(object) # Normalizes objects into a Timber::Context descendant.
         key = context.keyspace
         json = context.as_json # Convert to json now so that we aren't doing it for every line
         if key == :custom

data/lib/timber/event.rb

@@ -11,7 +11,7 @@ module Timber
     end
 
     def to_json(options = {})
-      Util::Hash.compact(as_json).to_json(options)
+      as_json.to_json(options)
     end
 
     def to_msgpack(*args)

data/lib/timber/events.rb

@@ -1,12 +1,13 @@
 require "timber/events/controller_call"
 require "timber/events/custom"
 require "timber/events/exception"
-require "timber/events/http_request"
-require "timber/events/http_response"
+require "timber/events/http_server_request"
+require "timber/events/http_server_response"
 require "timber/events/sql_query"
 require "timber/events/template_render"
 
 module Timber
+  # Namespace for all Timber supported events.
   module Events
     # Protocol for casting objects into a `Timber::Event`.
     #
@@ -17,17 +18,21 @@ module Timber
         obj
       elsif obj.respond_to?(:to_timber_event)
         obj.to_timber_event
-      elsif obj.is_a?(Hash) && obj.key?(:message) && obj.key?(:type) && obj.key?(:data)
+      elsif obj.is_a?(Hash) && obj.key?(:message) && obj.length == 2
+        event = obj.select { |k,v| k != :message }
+        type = event.keys.first
+        data = event.values.first
+
         Events::Custom.new(
-          type: obj[:type],
+          type: type,
           message: obj[:message],
-          data: obj[:data]
+          data: data
         )
       elsif obj.is_a?(Struct) && obj.respond_to?(:message) && obj.respond_to?(:type)
         Events::Custom.new(
           type: obj.type,
           message: obj.message,
-          data: obj.respond_to?(:hash) ? obj.hash : obj.to_h # ruby 1.9.3 does not have to_h
+          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

data/lib/timber/events/controller_call.rb

@@ -22,7 +22,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:controller_call => to_hash}
+        {:server_side_app => {:controller_call => to_hash}}
       end
 
       def message

data/lib/timber/events/custom.rb

@@ -31,7 +31,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:custom => to_hash}
+        {:server_side_app => {:custom => to_hash}}
       end
 
       def to_json(options = {})

data/lib/timber/events/exception.rb

@@ -19,7 +19,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:exception => to_hash}
+        {:server_side_app => {:exception => to_hash}}
       end
 
       def message

data/lib/timber/events/{http_request.rb → http_server_request.rb}

@@ -32,7 +32,7 @@ module Timber
         hash = to_hash
         hash[:headers] = Util::Hash.compact(hash[:headers])
         hash = Util::Hash.compact(hash)
-        {:http_request => hash}
+        {:server_side_app => {:http_request => hash}}
       end
 
       def message

data/lib/timber/events/{http_response.rb → http_server_response.rb}

@@ -10,6 +10,7 @@ module Timber
       def initialize(attributes)
         @status = attributes[:status] || raise(ArgumentError.new(":status is required"))
         @time_ms = attributes[:time_ms] || raise(ArgumentError.new(":time_ms is required"))
+        @time_ms = @time_ms.round(6)
         @additions = attributes[:additions]
       end
 
@@ -19,7 +20,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:http_response => to_hash}
+        {:server_side_app => {:http_server_response => to_hash}}
       end
 
       def message

data/lib/timber/events/sql_query.rb

@@ -10,6 +10,7 @@ module Timber
       def initialize(attributes)
         @sql = attributes[:sql] || raise(ArgumentError.new(":sql is required"))
         @time_ms = attributes[:time_ms] || raise(ArgumentError.new(":time_ms is required"))
+        @time_ms = @time_ms.round(6)
         @message = attributes[:message] || raise(ArgumentError.new(":message is required"))
       end
 
@@ -19,7 +20,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:sql_query => to_hash}
+        {:server_side_app => {:sql_query => to_hash}}
       end
     end
   end

data/lib/timber/events/template_render.rb

@@ -11,6 +11,7 @@ module Timber
         @message = attributes[:message] || raise(ArgumentError.new(":message is required"))
         @name = attributes[:name] || raise(ArgumentError.new(":name is required"))
         @time_ms = attributes[:time_ms] || raise(ArgumentError.new(":time_ms is required"))
+        @time_ms = @time_ms.round(6)
       end
 
       def to_hash
@@ -19,7 +20,7 @@ module Timber
       alias to_h to_hash
 
       def as_json(_options = {})
-        {:template_render => to_hash}
+        {:server_side_app => {:template_render => to_hash}}
       end
     end
   end

data/lib/timber/frameworks/rails.rb

@@ -5,7 +5,18 @@ module Timber
       class Railtie < ::Rails::Railtie
         config.timber = Config.instance
         config.before_initialize do
-          Probes.insert!(config.app_middleware, ::Rails::Rack::Logger)
+          Probes.insert!
+          Timber::Frameworks::Rails.insert_middlewares(config.app_middleware)
+        end
+      end
+
+      def self.insert_middlewares(middleware)
+        var_name = :"@_timber_middlewares_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)
+        Timber::RackMiddlewares.middlewares.each do |m|
+          middleware.insert_before ::Rails::Rack::Logger, m
         end
       end
     end

data/lib/timber/log_devices/http.rb

@@ -1,7 +1,7 @@
 module Timber
   module LogDevices
-    # A log device that buffers and delivers log messages over HTTPS to the Timber API.
-    # It uses batches, keep-alive connections, and messagepack to delivery logs with
+    # A highly efficient log device that buffers and delivers log messages over HTTPS to
+    # the Timber API. It uses batches, keep-alive connections, and msgpack to deliver logs with
     # high-throughput and little overhead.
     #
     # See {#initialize} for options and more details.
@@ -29,9 +29,7 @@ module Timber
         end
 
         def full?
-          @lock.synchronize do
-            size >= @max_size
-          end
+          size >= @max_size
         end
 
         def size
@@ -61,11 +59,9 @@ module Timber
       end
 
       TIMBER_URL = "https://logs.timber.io/frames".freeze
+      ACCEPT = "application/json".freeze
       CONTENT_TYPE = "application/msgpack".freeze
-      USER_AGENT = "Timber Ruby Gem/#{Timber::VERSION}".freeze
-      DELIVERY_FREQUENCY_SECONDS = 2.freeze
-      RETRY_LIMIT = 5.freeze
-      BACKOFF_RATE_SECONDS = 3.freeze
+      USER_AGENT = "Timber Ruby/#{Timber::VERSION} (HTTP)".freeze
 
 
       # Instantiates a new HTTP log device that can be passed to {Timber::Logger#initialize}.
@@ -81,14 +77,17 @@ module Timber
       # @param api_key [String] The API key provided to you after you add your application to
       #   [Timber](https://timber.io).
       # @param [Hash] options the options to create a HTTP log device with.
-      # @option attributes [Symbol] :batch_size (500) Determines the maximum of log lines in each HTTP
-      #   payload. If the queue exceeds this limit a HTTP request will be issued.
+      # @option attributes [Symbol] :batch_size (1000) Determines the maximum of log lines in
+      #   each HTTP payload. If the queue exceeds this limit an HTTP request will be issued. Bigger
+      #   payloads mean higher throughput, but also use more memory. Timber will not accept
+      #   payloads larger than 1mb.
       # @option attributes [Symbol] :debug (false) Whether to print debug output or not. This is also
       #   inferred from ENV['debug']. Output will be sent to `Timber::Config.logger`.
-      # @option attributes [Symbol] :flush_interval (2) How often the client should
-      #   attempt to deliver logs to the Timber API. The HTTP client buffers logs and this
-      #   options represents how often that will happen, assuming `:batch_byte_size` is not met.
-      # @option attributes [Symbol] :requests_per_conn (1000) The number of requests to send over a
+      # @option attributes [Symbol] :flush_interval (1) How often the client should
+      #   attempt to deliver logs to the Timber API in fractional seconds. The HTTP client buffers
+      #   logs and this options represents how often that will happen, assuming `:batch_byte_size`
+      #   is not met.
+      # @option attributes [Symbol] :requests_per_conn (2500) The number of requests to send over a
       #   single persistent connection. After this number is met, the connection will be closed
       #   and a new one will be opened.
       # @option attributes [Symbol] :request_queue (SizedQueue.new(3)) The request queue object that queues Net::HTTP
@@ -110,9 +109,9 @@ module Timber
         @api_key = api_key
         @debug = options[:debug] || ENV['debug']
         @timber_url = URI.parse(options[:timber_url] || ENV['TIMBER_URL'] || TIMBER_URL)
-        @batch_size = options[:batch_size] || 500
-        @flush_interval = options[:flush_interval] || 2 # 2 seconds
-        @requests_per_conn = options[:requests_per_conn] || 1_000
+        @batch_size = options[:batch_size] || 1_000
+        @flush_interval = options[:flush_interval] || 1 # 1 second
+        @requests_per_conn = options[:requests_per_conn] || 2_500
         @msg_queue = LogMsgQueue.new(@batch_size)
         @request_queue = options[:request_queue] || SizedQueue.new(3)
         @requests_in_flight = 0
@@ -128,6 +127,7 @@ module Timber
       def write(msg)
         @msg_queue.enqueue(msg)
         if @msg_queue.full?
+          logger.debug("Flushing timber buffer via write") if debug?
           flush
         end
         true
@@ -146,17 +146,17 @@ module Timber
         end
 
         def flush
+          @last_flush = Time.now
           msgs = @msg_queue.flush
           return if msgs.empty?
 
           req = Net::HTTP::Post.new(@timber_url.path)
-          req['Accept'] = "application/json"
+          req['Accept'] = ACCEPT
           req['Authorization'] = authorization_payload
           req['Content-Type'] = CONTENT_TYPE
           req['User-Agent'] = USER_AGENT
           req.body = msgs.to_msgpack
           @request_queue.enq(req)
-          @last_flush = Time.now
         end
 
         def intervaled_flush
@@ -165,11 +165,12 @@ module Timber
           loop do
             begin
               if intervaled_flush_ready?
+                logger.debug("Flushing timber buffer via the interval") if debug?
                 flush
               end
               sleep(0.1)
             rescue Exception => e
-              logger.error("Timber intervaled flush failed: #{e.inspect}")
+              logger.error("Timber intervaled flush failed: #{e.inspect}\n\n#{e.backtrace}")
             end
           end
         end
@@ -192,8 +193,12 @@ module Timber
               http.start do |conn|
                 num_reqs = 0
                 while num_reqs < @requests_per_conn
+                  if debug?
+                    logger.debug("Waiting on next Timber request")
+                    logger.debug("Number of threads waiting on Timber request queue: #{@request_queue.num_waiting}")
+                  end
+
                   # Blocks waiting for a request.
-                  logger.info("Waiting on next Timber request") if debug?
                   req = @request_queue.deq
                   @requests_in_flight += 1
                   resp = nil
@@ -206,13 +211,13 @@ module Timber
                     @requests_in_flight -= 1
                   end
                   num_reqs += 1
-                  logger.info("Timber request successful: #{resp.code}") if debug?
+                  logger.debug("Timber request successful: #{resp.code}") if debug?
                 end
               end
             rescue => e
               logger.error("Timber request error: #{e.message}") if debug?
             ensure
-              logger.info("Finishing Timber HTTP connection") if debug?
+              logger.debug("Finishing Timber HTTP connection") if debug?
               http.finish if http.started?
             end
           end

data/lib/timber/log_entry.rb

@@ -3,38 +3,50 @@ module Timber
   # `Logger` and the log device that you set it up with.
   class LogEntry #:nodoc:
     DT_PRECISION = 6.freeze
+    SCHEMA = "https://raw.githubusercontent.com/timberio/log-event-json-schema/1.2.3/schema.json".freeze
 
-    attr_reader :level, :time, :progname, :message, :context, :event
+    attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
     # Creates a log entry suitable to be sent to the Timber API.
     # @param severity [Integer] the log level / severity
     # @param time [Time] the exact time the log message was written
     # @param progname [String] the progname scope for the log message
-    # @param message [#to_json] structured data representing the log line event, this can
-    #   be anything that responds to #to_json
+    # @param message [String] Human readable log message.
+    # @param context_snapshot [Hash] structured data representing a snapshot of the context at
+    #   the given point in time.
+    # @param event [Timber.Event] structured data representing the log line event. This should be
+    #   an instance of `Timber.Event`.
     # @return [LogEntry] the resulting LogEntry object
-    def initialize(level, time, progname, message, context, event)
+    def initialize(level, time, progname, message, context_snapshot, event, tags)
       @level = level
       @time = time.utc
       @progname = progname
       @message = message
-      @context = context
+      @tags = tags
+
+      context_snapshot = {} if context_snapshot.nil?
+      system_context = Contexts::System.new(pid: Process.pid)
+      context_snapshot[system_context.keyspace] = system_context.as_json
+
+      @context_snapshot = context_snapshot
       @event = event
     end
 
     def as_json(options = {})
       options ||= {}
-      hash = {level: level, dt: formatted_dt, message: message}
+      hash = {:level => level, :dt => formatted_dt, :message => message, :tags => tags}
 
       if !event.nil?
         hash[:event] = event
       end
 
-      if !context.nil? && context.length > 0
-        hash[:context] = context
+      if !context_snapshot.nil? && context_snapshot.length > 0
+        hash[:context] = context_snapshot
       end
 
-      if options[:only]
+      hash[:"$schema"] = SCHEMA
+
+      hash = if options[:only]
         hash.select do |key, _value|
           options[:only].include?(key)
         end
@@ -45,6 +57,8 @@ module Timber
       else
         hash
       end
+
+      Util::Hash.compact(hash)
     end
 
     def to_json(options = {})