logtail 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be8318ce433573150e153c4def0b1583a7ff79cb23e66160b3a07662fe40346
-  data.tar.gz: 0ef24a7258f255d275ed26d18de1c1d31948c270eacbb93b85a1ff8fa1d635f9
+  metadata.gz: 9958b51a6821adf3e371746dde1dee7d661e4f9b40e492f69e249ed85d22ca80
+  data.tar.gz: 2b9db72344079fe012179853c192385a51419f082d44f1883b35401aba6bc869
 SHA512:
-  metadata.gz: 856d92f191144d4b827b5088fedc0963ef1a96a7e4ec8631e5883cb275ad9b7f5928dcfff0c2047dafb75ee0d8a40d798750457bbc3028b148fb3b6c1cf15320
-  data.tar.gz: 0ab7a3f459aaaffe7494e626f535190f2bb643b458b17cd9209ba4b399f6daf336fb8707851272c5b928050b573b5d29db61c4cf020ed3997ead233ca865b193
+  metadata.gz: 9826d94548c436782434831a5161267a6b1d0e8814441cde1b2cb51f53257d015b42c6ff7dabc422b42bd045432d34d8bf241e4305cad4a59d5cc0ec156a8f6d
+  data.tar.gz: f71fb5e1af5d3cb71b50880c120f91e1eb573bd72fe671a32ec96b90a093b0986433db76a7c0f892051a1a1131c15a432018247a90d836a255ffaf162a98f130

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/Rakefile

@@ -14,7 +14,7 @@ def puts_with_level(message, level = :info)
   end
 end
 
-task :test_the_pipes, [:api_key] do |t, args|
+task :test_the_pipes, [:source_token] do |t, args|
   support_email = "support@logtail.com"
   # Do not modify below this line. It's important to keep the `Logtail::Logger`
   # because it provides an API for logging structured data and capturing context.
@@ -26,7 +26,7 @@ task :test_the_pipes, [:api_key] do |t, args|
 
   current_context = Logtail::CurrentContext.instance.snapshot
   entry = Logtail::LogEntry.new(:info, Time.now, nil, "Testing the pipes (click the inspect icon to view more details)", current_context, nil)
-  http_device = Logtail::LogDevices::HTTP.new(args.api_key, flush_continuously: false)
+  http_device = Logtail::LogDevices::HTTP.new(args.source_token, flush_continuously: false)
   response = http_device.deliver_one(entry)
   if response.is_a?(Exception)
     message = <<~HEREDOC

data/lib/logtail/log_devices/http.rb

@@ -36,7 +36,7 @@ module Logtail
       # you can drop the log messages instead by passing a {DroppingSizedQueue} via the
       # `:request_queue` option.
       #
-      # @param api_key [String] The API key provided to you after you add your application to
+      # @param source_token [String] The API key provided to you after you add your application to
       #   [Logtail](https://logtail.com).
       # @param [Hash] options the options to create a HTTP log device with.
       # @option attributes [Symbol] :batch_size (1000) Determines the maximum of log lines in
@@ -64,13 +64,13 @@ module Logtail
       #   The default is set via {LOGTAIL_HOST}.
       #
       # @example Basic usage
-      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("my_logtail_api_key"))
+      #   Logtail::Logger.new(Logtail::LogDevices::HTTP.new("my_logtail_source_token"))
       #
       # @example Apply back pressure instead of dropping messages
-      #   http_log_device = Logtail::LogDevices::HTTP.new("my_logtail_api_key", request_queue: SizedQueue.new(25))
+      #   http_log_device = Logtail::LogDevices::HTTP.new("my_logtail_source_token", request_queue: SizedQueue.new(25))
       #   Logtail::Logger.new(http_log_device)
-      def initialize(api_key, options = {})
-        @api_key = api_key || raise(ArgumentError.new("The api_key parameter cannot be blank"))
+      def initialize(source_token, options = {})
+        @source_token = source_token || raise(ArgumentError.new("The source_token parameter cannot be blank"))
         @logtail_host = options[:logtail_host] || ENV['LOGTAIL_HOST'] || LOGTAIL_HOST
         @logtail_port = options[:logtail_port] || ENV['LOGTAIL_PORT'] || LOGTAIL_PORT
         @logtail_scheme = options[:logtail_scheme] || ENV['LOGTAIL_SCHEME'] || LOGTAIL_SCHEME
@@ -168,7 +168,7 @@ MESSAGE
         end
 
         raise <<-MESSAGE
-        
+
 Log delivery failed! No request was made.
 
 You can enable internal debug logging with the following:
@@ -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,
@@ -361,7 +371,7 @@ MESSAGE
 
         # Builds the `Authorization` header value for HTTP delivery to the Logtail API.
         def authorization_payload
-          "Bearer #{@api_key}"
+          "Bearer #{@source_token}"
         end
     end
   end

data/lib/logtail/log_entry.rb

@@ -1,5 +1,6 @@
 require "socket"
 require "time"
+require "pathname"
 
 require "logtail/contexts"
 require "logtail/events"
@@ -11,6 +12,7 @@ module Logtail
     BINARY_LIMIT_THRESHOLD = 1_000.freeze
     DT_PRECISION = 6.freeze
     MESSAGE_MAX_BYTES = 8192.freeze
+    LOGGER_FILE = '/logtail/logger.rb'.freeze
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
@@ -37,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).
@@ -45,7 +48,7 @@ module Logtail
       hash = {
         :level => level,
         :dt => formatted_dt,
-        :message => message
+        :message => message,
       }
 
       if !tags.nil? && tags.length > 0
@@ -60,6 +63,10 @@ module Logtail
         hash[:context] = context_snapshot
       end
 
+      hash[:context] ||= {}
+      hash[:context][:runtime] ||= {}
+      hash[:context][:runtime].merge!(@runtime_context)
+
       if options[:only]
         hash.select do |key, _value|
           options[:only].include?(key)
@@ -106,5 +113,42 @@ module Logtail
       rescue Exception
         nil
       end
+
+      def current_runtime_context
+        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 convert_to_runtime_context(frame)
+      end
+
+      def convert_to_runtime_context(frame)
+        {
+          file: path_relative_to_app_root(frame),
+          line: frame.lineno,
+          frame_label: frame.label,
+        }
+      end
+
+      def logtail_logger_frame?(frame)
+        !frame.absolute_path.nil? && frame.absolute_path.end_with?(LOGGER_FILE)
+      end
+
+      def path_relative_to_app_root(frame)
+        Pathname.new(frame.absolute_path).relative_path_from(root_path).to_s
+      end
+
+      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
@@ -135,7 +135,7 @@ module Logtail
     #   logger = Logtail::Logger.new(STDOUT)
     #
     # @example Logging to the Logtail HTTP device
-    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-api-key")
+    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-source-token")
     #   logger = Logtail::Logger.new(http_device)
     #
     # @example Logging to a file (with rotation)
@@ -143,7 +143,7 @@ module Logtail
     #   logger = Logtail::Logger.new(file_device)
     #
     # @example Logging to a file and the Logtail HTTP device (multiple log devices)
-    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-api-key")
+    #   http_device = Logtail::LogDevices::HTTP.new("my-logtail-source-token")
     #   file_logger = ::Logger.new("path/to/file.log")
     #   logger = Logtail::Logger.new(http_device, file_logger)
     def initialize(*io_devices_and_loggers)

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/spec/logtail/log_devices/http_spec.rb

@@ -102,7 +102,7 @@ describe Logtail::LogDevices::HTTP do
       request_queue = http.instance_variable_get(:@request_queue)
       request_attempt = request_queue.deq
       expect(request_attempt.request).to be_kind_of(Net::HTTP::Post)
-      expect(request_attempt.request.body).to start_with("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT"))
+      expect(request_attempt.request.body).to start_with("\x92\x84\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT"))
 
       message_queue = http.instance_variable_get(:@msg_queue)
       expect(message_queue.size).to eq(0)
@@ -127,7 +127,7 @@ describe Logtail::LogDevices::HTTP do
     it "should deliver requests on an interval" do
       stub = stub_request(:post, "https://in.logtail.com/").
         with(
-          :body => start_with("\x92\x83\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
+          :body => start_with("\x92\x84\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12:00:00.000000Z\xA7message\xB2test log message 1".force_encoding("ASCII-8BIT")),
           :headers => {
             'Authorization' => 'Bearer MYKEY',
             'Content-Type' => 'application/msgpack',

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,7 +16,20 @@ 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
+      log_entry = Logtail::Logger::PassThroughFormatter.new.call("INFO", time, "", "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 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
 end

data/spec/logtail/logger_spec.rb

@@ -161,7 +161,7 @@ describe Logtail::Logger do
     end
 
     context "with the HTTP log device" do
-      let(:io) { Logtail::LogDevices::HTTP.new("my_key") }
+      let(:io) { Logtail::LogDevices::HTTP.new("my_source_token") }
 
       it "should use the PassThroughFormatter" do
         expect(logger.formatter).to be_kind_of(Logtail::Logger::PassThroughFormatter)
@@ -189,7 +189,7 @@ describe Logtail::Logger do
 
   describe "#formatter=" do
     it "should not allow changing the formatter when the device is HTTP" do
-      http_device = Logtail::LogDevices::HTTP.new("api_key")
+      http_device = Logtail::LogDevices::HTTP.new("source_token")
       logger = Logtail::Logger.new(http_device)
       expect { logger.formatter = ::Logger::Formatter.new }.to raise_error(ArgumentError)
     end

metadata

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