timber 2.6.2 → 3.0.0

data/lib/timber/events/error.rb

@@ -1,38 +1,20 @@
-require "timber/event"
 require "timber/util"
+require "timber/event"
 
 module Timber
   module Events
-    # The error event is used to track errors and exceptions.
-    #
-    # @note This event should be installed automatically through integrations,
-    #   such as the {Integrations::ActionDispatch::DebugExceptions} integration.
+    # @private
     class Error < Timber::Event
-      BACKTRACE_JSON_MAX_BYTES = 8192.freeze
-      MESSAGE_MAX_BYTES = 8192.freeze
-
-      attr_reader :name, :error_message, :backtrace
+      attr_reader :name, :error_message, :backtrace_json
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @name = normalizer.fetch!(:name, :string)
-        @error_message = normalizer.fetch(:error_message, :string, :limit => MESSAGE_MAX_BYTES)
-        @backtrace = normalizer.fetch(:backtrace, :array)
-      end
+        @name = attributes[:name]
+        @error_message = attributes[:error_message]
 
-      def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:name, name)
-          h.add(:message, error_message)
-          h.add(:backtrace_json, backtrace, :json_encode => true, :limit => BACKTRACE_JSON_MAX_BYTES)
+        if attributes[:backtrace]
+          @backtrace_json = attributes[:backtrace].to_json
         end
       end
-      alias to_h to_hash
-
-      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
-      def as_json(_options = {})
-        {:error => to_hash}
-      end
 
       def message
         message = "#{name}"
@@ -43,6 +25,16 @@ module Timber
 
         message
       end
+
+      def to_hash
+        {
+          error: {
+            name: name,
+            message: error_message,
+            backtrace_json: backtrace_json
+          }
+        }
+      end
     end
   end
-end
+end

data/lib/timber/events/exception.rb

@@ -3,6 +3,7 @@ require "timber/events/error"
 module Timber
   module Events
     # DEPRECATION: This class is deprecated in favor of using {Timber:Events:Error}.
+    # @private
     class Exception < Error
     end
   end

data/lib/timber/events/sql_query.rb

@@ -1,36 +1,26 @@
-require "timber/event"
+require 'timber/util'
+require 'timber/event'
 
 module Timber
   module Events
-    # The SQL query event tracks sql queries to your database.
-    #
-    # @note This event should be installed automatically through integrations,
-    #   such as the {Integrations::ActiveRecord::LogSubscriber} integration.
+    # @private
     class SQLQuery < Timber::Event
-      MESSAGE_MAX_BYTES = 8192.freeze
-      SQL_MAX_BYTES = 4096.freeze
-
-      attr_reader :sql, :time_ms, :message
+      attr_reader :sql, :duration_ms, :message
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @message = normalizer.fetch!(:message, :string, :limit => MESSAGE_MAX_BYTES)
-        @sql = normalizer.fetch!(:sql, :string, :limit => SQL_MAX_BYTES)
-        @time_ms = normalizer.fetch!(:time_ms, :float, :precision => 6)
+        @sql = attributes[:sql]
+        @duration_ms = attributes[:duration_ms]
+        @message = attributes[:message]
       end
 
       def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:sql, sql)
-          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 = {})
-        {:sql_query => to_hash}
+        {
+          sql_query_executed: Util::NonNilHashBuilder.build do |h|
+            h.add(:sql, sql)
+            h.add(:duration_ms, duration_ms)
+          end
+        }
       end
     end
   end
-end
+end

data/lib/timber/events/template_render.rb

@@ -1,36 +1,25 @@
+require "timber/util"
 require "timber/event"
-
 module Timber
   module Events
-    # The template render event track template renderings and their performance.
-    #
-    # @note This event should be installed automatically through integrations,
-    #   such as the {Integrations::ActionView::LogSubscriber} integration.
+    # @private
     class TemplateRender < Timber::Event
-      MESSAGE_MAX_BYTES = 8192.freeze
-      NAME_MAX_BYTES = 1024.freeze
-
-      attr_reader :message, :name, :time_ms
+      attr_reader :message, :name, :duration_ms
 
       def initialize(attributes)
-        normalizer = Util::AttributeNormalizer.new(attributes)
-        @message = normalizer.fetch!(:message, :string, :limit => MESSAGE_MAX_BYTES)
-        @name = normalizer.fetch!(:name, :string, :limit => NAME_MAX_BYTES)
-        @time_ms = normalizer.fetch!(:time_ms, :float, :precision => 6)
+        @name = attributes[:name]
+        @duration_ms = attributes[:duration_ms]
+        @message = attributes[:message]
       end
 
       def to_hash
-        @to_hash ||= Util::NonNilHashBuilder.build do |h|
-          h.add(:name, name)
-          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 = {})
-        {:template_render => to_hash}
+        {
+          template_rendered: Util::NonNilHashBuilder.build do |h|
+            h.add(:name, name)
+            h.add(:duration_ms, duration_ms)
+          end
+        }
       end
     end
   end
-end
+end

data/lib/timber/integration.rb

@@ -37,4 +37,4 @@ module Timber
       raise NotImplementedError.new
     end
   end
-end
+end

data/lib/timber/integrator.rb

@@ -47,4 +47,4 @@ module Timber
       raise NotImplementedError.new
     end
   end
-end
+end

data/lib/timber/log_devices/http.rb

@@ -17,9 +17,11 @@ module Timber
     #
     # See {#initialize} for options and more details.
     class HTTP
-      TIMBER_STAGING_URL = "https://logs-staging.timber.io/frames".freeze
-      TIMBER_PRODUCTION_URL = "https://logs.timber.io/frames".freeze
-      TIMBER_URL = ENV['TIMBER_STAGING'] ? TIMBER_STAGING_URL : TIMBER_PRODUCTION_URL
+      TIMBER_STAGING_HOST = "logs-staging.timber.io".freeze
+      TIMBER_PRODUCTION_HOST = "logs.timber.io".freeze
+      TIMBER_HOST = ENV['TIMBER_STAGING'] ? TIMBER_STAGING_HOST : TIMBER_PRODUCTION_HOST
+      TIMBER_PORT = 443
+      TIMBER_SCHEME = "https".freeze
       CONTENT_TYPE = "application/msgpack".freeze
       USER_AGENT = "Timber Ruby/#{Timber::VERSION} (HTTP)".freeze
 
@@ -58,8 +60,8 @@ module Timber
       #   requests new requests will be dropped. If you'd prefer to apply back pressure,
       #   ensuring you do not lose log data, pass a standard {SizedQueue}. See examples for
       #   an example.
-      # @option attributes [Symbol] :timber_url The Timber URL to delivery the log lines. The
-      #   default is set via {TIMBER_URL}.
+      # @option attributes [Symbol] :timber_host The Timber host to delivery the log lines to.
+      #   The default is set via {TIMBER_HOST}.
       #
       # @example Basic usage
       #   Timber::Logger.new(Timber::LogDevices::HTTP.new("my_timber_api_key"))
@@ -67,9 +69,21 @@ module Timber
       # @example Apply back pressure instead of dropping messages
       #   http_log_device = Timber::LogDevices::HTTP.new("my_timber_api_key", request_queue: SizedQueue.new(25))
       #   Timber::Logger.new(http_log_device)
-      def initialize(api_key, options = {})
+      def initialize(api_key, *args)
+        options = {}
+
+        # Timber 3.0 introduced a second argument `source_id` which is required for the new
+        # Timber API keys. For backwards compability we still support the old source specific
+        # API keys that do not require an explicit source ID.
+        if args.last.is_a?(Hash)
+          options = args.pop
+        end
+
         @api_key = api_key || raise(ArgumentError.new("The api_key parameter cannot be blank"))
-        @timber_url = URI.parse(options[:timber_url] || ENV['TIMBER_URL'] || TIMBER_URL)
+        @source_id = args.first
+        @timber_host = options[:timber_host] || ENV['TIMBER_HOST'] || TIMBER_HOST
+        @timber_port = options[:timber_port] || ENV['TIMBER_PORT'] || TIMBER_PORT
+        @timber_scheme = options[:timber_scheme] || ENV['TIMBER_SCHEME'] || TIMBER_SCHEME
         @batch_size = options[:batch_size] || 1_000
         @flush_continuously = options[:flush_continuously] != false
         @flush_interval = options[:flush_interval] || 2 # 2 seconds
@@ -121,6 +135,58 @@ module Timber
         @request_outlet_thread.kill if @request_outlet_thread
       end
 
+      def deliver_one(msg)
+        http = build_http
+
+        begin
+          resp = http.start do |conn|
+            req = build_request([msg])
+            @requests_in_flight += 1
+            conn.request(req)
+          end
+          return resp
+        rescue => e
+          Timber::Config.instance.debug { "error: #{e.message}" }
+          return e
+        ensure
+          http.finish if http.started?
+          @requests_in_flight -= 1
+        end
+      end
+
+      def verify_delivery!
+        5.times do |i|
+          sleep(2)
+
+          if @last_resp.nil?
+            print "."
+          elsif @last_resp.code == "202"
+            puts "Log delivery successful! View your logs at https://app.timber.io"
+          else
+            raise <<-MESSAGE
+
+Log delivery failed!
+
+Status: #{@last_resp.code}
+Body: #{@last_resp.body}
+
+You can enable internal Timber debug logging with the following:
+
+Timber::Config.instance.debug_logger = ::Logger.new(STDOUT)
+MESSAGE
+          end
+        end
+
+        raise <<-MESSAGE
+        
+Log delivery failed! No request was made.
+
+You can enable internal debug logging with the following:
+
+Timber::Config.instance.debug_logger = ::Logger.new(STDOUT)
+MESSAGE
+      end
+
       private
         # This is a convenience method to ensure the flush thread are
         # started. This is called lazily from {#write} so that we
@@ -139,15 +205,12 @@ module Timber
         end
 
         # Builds an HTTP request based on the current messages queued.
-        def build_request
-          msgs = @msg_queue.flush
-          return if msgs.empty?
-
-          req = Net::HTTP::Post.new(@timber_url.path)
+        def build_request(msgs)
+          path = @source_id.nil? ? "/frames" : "/sources/#{@source_id}/frames"
+          req = Net::HTTP::Post.new(path)
           req['Authorization'] = authorization_payload
           req['Content-Type'] = CONTENT_TYPE
           req['User-Agent'] = USER_AGENT
-
           req.body = msgs.to_msgpack
           req
         end
@@ -159,7 +222,10 @@ module Timber
         # imposed limit.
         def flush_async
           @last_async_flush = Time.now
-          req = build_request
+          msgs = @msg_queue.flush
+          return if msgs.empty?
+
+          req = build_request(msgs)
           if !req.nil?
             Timber::Config.instance.debug { "New request placed on queue" }
             request_attempt = RequestAttempt.new(req)
@@ -214,9 +280,9 @@ module Timber
 
         # Builds an `Net::HTTP` object to deliver requests over.
         def build_http
-          http = Net::HTTP.new(@timber_url.host, @timber_url.port)
+          http = Net::HTTP.new(@timber_host, @timber_port)
           http.set_debug_output(Config.instance.debug_logger) if Config.instance.debug_logger
-          if @timber_url.scheme == 'https'
+          if @timber_scheme == 'https'
             http.use_ssl = true
             # Verification on Windows fails despite having a valid certificate.
             http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -287,7 +353,16 @@ module Timber
               end
 
               num_reqs += 1
-              Timber::Config.instance.debug { "Request successful: #{resp.code}" }
+
+              @last_resp = resp
+
+              Timber::Config.instance.debug do
+                if resp.code == "202"
+                  "Logs successfully sent! View your logs at https://app.timber.io"
+                else
+                  "Log delivery failed! status: #{resp.code}, body: #{resp.body}"
+                end
+              end
             end
           end
 
@@ -296,8 +371,12 @@ module Timber
 
         # Builds the `Authorization` header value for HTTP delivery to the Timber API.
         def authorization_payload
-          @authorization_payload ||= "Basic #{Base64.urlsafe_encode64(@api_key).chomp}"
+          @authorization_payload ||= if @source_id.nil?
+            "Basic #{Base64.urlsafe_encode64(@api_key).chomp}"
+          else
+            "Bearer #{@api_key}"
+          end
         end
     end
   end
-end
+end

data/lib/timber/log_entry.rb

@@ -11,7 +11,6 @@ module Timber
     BINARY_LIMIT_THRESHOLD = 1_000.freeze
     DT_PRECISION = 6.freeze
     MESSAGE_MAX_BYTES = 8192.freeze
-    SCHEMA = "https://raw.githubusercontent.com/timberio/log-event-json-schema/v3.2.0/schema.json".freeze
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
@@ -41,7 +40,7 @@ module Timber
     end
 
     # Builds a hash representation containing simple objects, suitable for serialization (JSON).
-    def as_json(options = {})
+    def to_hash(options = {})
       options ||= {}
       hash = {
         :level => level,
@@ -54,15 +53,13 @@ module Timber
       end
 
       if !event.nil?
-        hash[:event] = event.as_json
+        hash.merge!(event)
       end
 
       if !context_snapshot.nil? && context_snapshot.length > 0
         hash[:context] = context_snapshot
       end
 
-      hash[:"$schema"] = SCHEMA
-
       if options[:only]
         hash.select do |key, _value|
           options[:only].include?(key)
@@ -81,31 +78,16 @@ module Timber
     end
 
     def to_json(options = {})
-      as_json(options).to_json
+      to_hash.to_json
     end
 
     def to_msgpack(*args)
-      as_json.to_msgpack(*args)
+      to_hash.to_msgpack(*args)
     end
 
     # This is used when LogEntry objects make it to a non-Timber logger.
     def to_s
-      log_message = message
-
-      if !event.nil?
-        event_hash = event.as_json
-        event_type = event_hash.keys.first
-
-        event_type = if event.is_a?(Events::Custom)
-          "#{event_type}.#{event.type}"
-        else
-          "#{event_type}"
-        end
-
-        log_message = "#{message} [#{event_type}]"
-      end
-
-      log_message + "\n"
+      message + "\n"
     end
 
     private
@@ -125,4 +107,4 @@ module Timber
         nil
       end
   end
-end
+end

data/lib/timber/logger.rb

@@ -3,7 +3,6 @@ require "msgpack"
 
 require "timber/config"
 require "timber/current_context"
-require "timber/event"
 require "timber/log_devices"
 require "timber/log_entry"
 
@@ -39,7 +38,7 @@ module Timber
 
           if logged_obj.is_a?(Event)
             LogEntry.new(level, time, progname, logged_obj.message, context_snapshot, logged_obj,
-              tags: tags)
+                         tags: tags)
           elsif logged_obj.is_a?(Hash)
             # Extract the tags
             tags = tags.clone
@@ -47,11 +46,9 @@ module Timber
             tags.concat(logged_obj.delete(:tags)) if logged_obj.key?(:tags)
             tags.uniq!
 
-            # Build the event
-            event = Events.build(logged_obj)
-            message = event ? event.message : logged_obj[:message]
+            message = logged_obj.delete(:message)
 
-            LogEntry.new(level, time, progname, message, context_snapshot, event, tags: tags)
+            LogEntry.new(level, time, progname, message, context_snapshot, logged_obj, tags: tags)
           else
             LogEntry.new(level, time, progname, logged_obj, context_snapshot, nil, tags: tags)
           end
@@ -126,12 +123,6 @@ module Timber
       end
     end
 
-    # These are rails modules that change the logger behavior. We have to
-    # include these if they are present or the logger will not function properly
-    # in a rails environment.
-    include ::ActiveSupport::LoggerThreadSafeLevel if defined?(::ActiveSupport::LoggerThreadSafeLevel)
-    include ::LoggerSilence if defined?(::LoggerSilence)
-
     # Creates a new Timber::Logger instance where the passed argument is an IO device. That is,
     # anything that responds to `#write` and `#close`.
     #
@@ -185,7 +176,7 @@ module Timber
       elsif Config.instance.development? || Config.instance.test?
         self.formatter = MessageOnlyFormatter.new
       else
-        self.formatter = AugmentedFormatter.new
+        self.formatter = JSONFormatter.new
       end
 
       self.level = environment_level
@@ -276,4 +267,4 @@ module Timber
         obj.respond_to?(:debug) && obj.respond_to?(:info) && obj.respond_to?(:warn)
       end
   end
-end
+end