logtail 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a701070a19f4a33ac78a22d48f7eb3f9c2a6f794bf1e1abcc95a535d29fc9c0
-  data.tar.gz: fc2ed9e71f8d4b6c43ec5b18d2f28b55e4bc05163da236fda364081147b6fd8b
+  metadata.gz: 0af39db5d892f490e82d5c495f4e51b0646f418a13d4b940566c997aff7e5b1a
+  data.tar.gz: c3e756d0ecc74b2d8128d43914cf677458edce92c8d3bf261047f23a8ae54d65
 SHA512:
-  metadata.gz: bc08401deaf074e084929ac7964a90680adc463077466ba95b170022f4b30438c339d5fb8ea47e468ffbb94b9be34e2da13270bc829d59148ae208be4d4f2092
-  data.tar.gz: a1d1518ce6c835031eb6c01b945df19d7fec6626905aa4c49c830d73619bd617f1452d6fe3596ae28a90ac0bc46b8f33bad4d7437f1f912323a0997495d115d9
+  metadata.gz: abd7b6e30cbaa22c698259a59fdaf31a1f46b5c194a14ee9f24b03db08140876c19d25784038235574d9ddbd4b2429ae09f85400291767be88bae60adf023354
+  data.tar.gz: e99b8366d6dcd585f0472091e48b3e4f17f350a3d7ff3a8d97c05022e821a7ab1c05daf5420a512eec76e18ea7e53c3367429bddd53dfeea6488951c9e844c9c

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [1.0.0] - 2021-02-11
+## [0.1.0] - 2021-02-11
 
 - The first version of the client.
+
+## [0.1.2] - 2021-04-22
+
+- Fixed string encoding.
+
+## [0.1.3] - 2021-06-11
+
+- Fixed detection of the frame that calls the logger.

data/lib/logtail/log_devices/http.rb

@@ -201,10 +201,20 @@ MESSAGE
           req['Authorization'] = authorization_payload
           req['Content-Type'] = CONTENT_TYPE
           req['User-Agent'] = USER_AGENT
-          req.body = msgs.to_msgpack
+          req.body = msgs.map { |msg| force_utf8_encoding(msg.to_hash) }.to_msgpack
           req
         end
 
+        def force_utf8_encoding(data)
+          if data.respond_to?(:force_encoding)
+            data.dup.force_encoding('UTF-8')
+          elsif data.respond_to?(:transform_values)
+            data.transform_values { |val| force_utf8_encoding(val) }
+          else
+            data
+          end
+        end
+
         # Flushes the message buffer asynchronously. The reason we provide this
         # method is because the message buffer limit is constricted by the
         # Logtail API. The application limit is multiples of the buffer limit,

data/lib/logtail/log_entry.rb

@@ -12,7 +12,7 @@ module Logtail
     BINARY_LIMIT_THRESHOLD = 1_000.freeze
     DT_PRECISION = 6.freeze
     MESSAGE_MAX_BYTES = 8192.freeze
-    LOGTAIL_GEM_REGEX = /\/logtail(?:-ruby|-rails|-rack)?(?:-\d+(?:\.\d+)*)?\/lib$/.freeze
+    LOGGER_FILE = '/logtail/logger.rb'.freeze
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
@@ -39,6 +39,7 @@ module Logtail
       @tags = options[:tags]
       @context_snapshot = context_snapshot
       @event = event
+      @runtime_context = current_runtime_context || {}
     end
 
     # Builds a hash representation containing simple objects, suitable for serialization (JSON).
@@ -64,7 +65,7 @@ module Logtail
 
       hash[:context] ||= {}
       hash[:context][:runtime] ||= {}
-      hash[:context][:runtime].merge!(current_runtime_context || {})
+      hash[:context][:runtime].merge!(@runtime_context)
 
       if options[:only]
         hash.select do |key, _value|
@@ -114,32 +115,43 @@ module Logtail
       end
 
       def current_runtime_context
-        index = caller_locations.rindex { |x| logtail_frame?(x) }
-        frame = caller_locations[index + 1] unless index.nil?
-        return convert_to_runtime_context(frame) unless frame.nil?
+        last_logger_invocation_index = caller_locations.rindex { |frame| logtail_logger_frame?(frame) }
+        return {} if last_logger_invocation_index.nil?
+
+        calling_frame_index = last_logger_invocation_index + 1
+        frame = caller_locations[calling_frame_index]
+        return {} if frame.nil?
+
+        return convert_to_runtime_context(frame)
       end
 
       def convert_to_runtime_context(frame)
         {
-          file: relative_to_main_module(frame.absolute_path),
+          file: path_relative_to_app_root(frame),
           line: frame.lineno,
           frame_label: frame.label,
         }
       end
 
-      def logtail_frame?(frame)
-        return false if frame.absolute_path.nil? || logtail_gem_paths.empty?
-        logtail_gem_paths.any? { |path| frame.absolute_path.start_with?(path) }
+      def logtail_logger_frame?(frame)
+        !frame.absolute_path.nil? && frame.absolute_path.end_with?(LOGGER_FILE)
       end
 
-      def logtail_gem_paths
-        @logtail_gem_paths ||= $LOAD_PATH.select { |path| path.match(LOGTAIL_GEM_REGEX) }
+      def path_relative_to_app_root(frame)
+        Pathname.new(frame.absolute_path).relative_path_from(root_path).to_s
+      rescue
+        frame.absolute_path
       end
 
-      def relative_to_main_module(path)
-        base_file = caller_locations.last.absolute_path
-        base_path = Pathname.new(File.dirname(base_file || '/'))
-        Pathname.new(path).relative_path_from(base_path).to_s
+      def root_path
+        if Object.const_defined?('Rails')
+          Rails.root
+        elsif Object.const_defined?('Rack::Directory')
+          Pathname.new(Rack::Directory.new('').root)
+        else
+          base_file = caller_locations.last.absolute_path
+          Pathname.new(File.dirname(base_file || '/'))
+        end
       end
   end
 end

data/lib/logtail/logger.rb

@@ -34,14 +34,13 @@ module Logtail
         def build_log_entry(severity, time, progname, logged_obj)
           context_snapshot = CurrentContext.instance.snapshot
           level = SEVERITY_MAP.fetch(severity)
-          tags = extract_active_support_tagged_logging_tags
+          tags = extract_active_support_tagged_logging_tags.clone
 
           if logged_obj.is_a?(Event)
             LogEntry.new(level, time, progname, logged_obj.message, context_snapshot, logged_obj,
                          tags: tags)
           elsif logged_obj.is_a?(Hash)
             # Extract the tags
-            tags = tags.clone
             tags.push(logged_obj.delete(:tag)) if logged_obj.key?(:tag)
             tags.concat(logged_obj.delete(:tags)) if logged_obj.key?(:tags)
             tags.uniq!
@@ -56,7 +55,8 @@ module Logtail
 
         # Because of all the crazy ways Rails has attempted tags, we need this crazy method.
         def extract_active_support_tagged_logging_tags
-          Thread.current[:activesupport_tagged_logging_tags] ||
+          @current_tags ||
+            Thread.current[:activesupport_tagged_logging_tags] ||
             Thread.current[tagged_logging_object_key_name] ||
             EMPTY_ARRAY
         end

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

data/spec/logtail/log_entry_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Logtail::LogEntry do
-  let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+  let(:time) { Time.utc(2021, 06, 11, 12, 0, 0) }
 
   describe "#to_msgpack" do
     it "should encode properly with an event and context" do
@@ -16,20 +16,19 @@ describe Logtail::LogEntry do
       context = {custom: {a: "b"}}
       log_entry = described_class.new("INFO", time, nil, "log message", context, event)
       msgpack = log_entry.to_msgpack
-      expect(msgpack).to start_with("\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z".force_encoding("ASCII-8BIT"))
+      expect(msgpack).to start_with("\x85\xA5level\xA4INFO\xA2dt\xBB2021-06-11T12:00:00.000000Z".force_encoding("ASCII-8BIT"))
     end
   end
 
   describe "#to_hash" do
     it "should include runtime context information" do
-      $:.unshift(File.expand_path(__dir__ + '/../../lib'))
+      log_entry = Logtail::Logger::PassThroughFormatter.new.call("INFO", time, "", "log message")
 
-      log_entry = described_class.new("INFO", time, nil, "log message", {}, {})
       hash = log_entry.to_hash
       expect(hash[:context]).to_not be_nil
       expect(hash[:context][:runtime]).to_not be_nil
-      expect(hash[:context][:runtime][:file]).to_not be_nil
-      expect(hash[:context][:runtime][:line]).to_not be_nil
+      expect(hash[:context][:runtime][:file]).to end_with('/spec/logtail/log_entry_spec.rb')
+      expect(hash[:context][:runtime][:line]).to be(25)
       expect(hash[:context][:runtime][:frame_label]).to_not be_nil
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack