logtail 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be8318ce433573150e153c4def0b1583a7ff79cb23e66160b3a07662fe40346
-  data.tar.gz: 0ef24a7258f255d275ed26d18de1c1d31948c270eacbb93b85a1ff8fa1d635f9
+  metadata.gz: 5a701070a19f4a33ac78a22d48f7eb3f9c2a6f794bf1e1abcc95a535d29fc9c0
+  data.tar.gz: fc2ed9e71f8d4b6c43ec5b18d2f28b55e4bc05163da236fda364081147b6fd8b
 SHA512:
-  metadata.gz: 856d92f191144d4b827b5088fedc0963ef1a96a7e4ec8631e5883cb275ad9b7f5928dcfff0c2047dafb75ee0d8a40d798750457bbc3028b148fb3b6c1cf15320
-  data.tar.gz: 0ab7a3f459aaaffe7494e626f535190f2bb643b458b17cd9209ba4b399f6daf336fb8707851272c5b928050b573b5d29db61c4cf020ed3997ead233ca865b193
+  metadata.gz: bc08401deaf074e084929ac7964a90680adc463077466ba95b170022f4b30438c339d5fb8ea47e468ffbb94b9be34e2da13270bc829d59148ae208be4d4f2092
+  data.tar.gz: a1d1518ce6c835031eb6c01b945df19d7fec6626905aa4c49c830d73619bd617f1452d6fe3596ae28a90ac0bc46b8f33bad4d7437f1f912323a0997495d115d9

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:
@@ -361,7 +361,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
+    LOGTAIL_GEM_REGEX = /\/logtail(?:-ruby|-rails|-rack)?(?:-\d+(?:\.\d+)*)?\/lib$/.freeze
 
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time
 
@@ -45,7 +47,7 @@ module Logtail
       hash = {
         :level => level,
         :dt => formatted_dt,
-        :message => message
+        :message => message,
       }
 
       if !tags.nil? && tags.length > 0
@@ -60,6 +62,10 @@ module Logtail
         hash[:context] = context_snapshot
       end
 
+      hash[:context] ||= {}
+      hash[:context][:runtime] ||= {}
+      hash[:context][:runtime].merge!(current_runtime_context || {})
+
       if options[:only]
         hash.select do |key, _value|
           options[:only].include?(key)
@@ -106,5 +112,34 @@ module Logtail
       rescue Exception
         nil
       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?
+      end
+
+      def convert_to_runtime_context(frame)
+        {
+          file: relative_to_main_module(frame.absolute_path),
+          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) }
+      end
+
+      def logtail_gem_paths
+        @logtail_gem_paths ||= $LOAD_PATH.select { |path| path.match(LOGTAIL_GEM_REGEX) }
+      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
+      end
   end
 end

data/lib/logtail/logger.rb

@@ -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.1"
 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

@@ -19,4 +19,18 @@ describe Logtail::LogEntry do
       expect(msgpack).to start_with("\x85\xA5level\xA4INFO\xA2dt\xBB2016-09-01T12: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 = 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][: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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logtail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Logtail