logtail-ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a1b5ff5c6415b72a76574ad17cdf273b69a2ee163f3751c982b933f92518379
-  data.tar.gz: ddcddf4086118f54a0528ed76b6c550f30e9f0c39be44b016116a736bcf1b104
+  metadata.gz: 47c1ca6bdaee5eaf634fb6a058366c393f74bc75c295d96cdcca3f1f36f3f7fb
+  data.tar.gz: 2e7ac265ac46b0da133afd23a368fbeb0e8097aa23400c074627490251953065
 SHA512:
-  metadata.gz: d64a8e17cb3fc10dbb19d4582979383aa3efd478e7f0284e84e82f1e4ea732c228c2f1d0954ae16d4d6ef44f17dcf18a351f2e91fa5eab5611b4f7b3ff2c768c
-  data.tar.gz: bdce70cae9d0b3aa09128a63ab252e74d5c0bda77eb044a9fd5c5989ce5a52659ff8ab869aaf8438e5371ad6fb0a626b85748febb50a85126da5bc0f2bc1ed5b
+  metadata.gz: 79b04cbef17d3dee4fb6ce5a4c7dc5514f63aa511ab12298ebd9ec421c1d4c8cbc1a9bd9f8bad8685bc0442ae36b739aea0f78d76fad43a3257e6d68ec3bc369
+  data.tar.gz: 948a849a7714c8aa8ca24315121ac40a3a94ca7acd0f5a9d78afc53a25dde2ecbaa09141085690d32de147794c035d3ac0eab73b6fdbd2ec4dbcc35369ac33ee

data/CHANGELOG.md

@@ -7,6 +7,10 @@ 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.

data/Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in logtail-ruby.gemspec
+# Specify your gem's dependencies in logtail.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

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

@@ -17,7 +17,7 @@ module Logtail
     #
     # See {#initialize} for options and more details.
     class HTTP
-      LOGTAIL_STAGING_HOST = "in-staging.logtail.com".freeze
+      LOGTAIL_STAGING_HOST = "in.logtail.dev".freeze
       LOGTAIL_PRODUCTION_HOST = "in.logtail.com".freeze
       LOGTAIL_HOST = ENV['LOGTAIL_STAGING'] ? LOGTAIL_STAGING_HOST : LOGTAIL_PRODUCTION_HOST
       LOGTAIL_PORT = 443
@@ -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
+    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)
@@ -186,6 +186,8 @@ module Logtail
       Logtail::Config.instance.debug { "Logtail::Logger instantiated, level: #{level}, formatter: #{formatter.class}" }
 
       @initialized = true
+
+      self.warn("The 'logtail-ruby' package has been deprecated. Please, switch to 'logtail' https://rubygems.org/gems/logtail")
     end
 
     # Sets a new formatted on the logger.

data/lib/logtail/version.rb

@@ -1,3 +1,3 @@
 module Logtail
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/{logtail-ruby.gemspec → logtail.gemspec}

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/logtail/logtail-ruby"
   spec.license       = "ISC"
 
-  spec.summary       = "Query logs like you query your database. https://logtail.com"
+  spec.summary       = "This package has been deprecated. Please, switch to 'logtail' https://rubygems.org/gems/logtail"
 
   spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
   spec.metadata["changelog_uri"] = "#{spec.homepage}/tree/master/CHANGELOG.md"

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logtail-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Logtail
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2023-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -183,7 +183,7 @@ files:
 - lib/logtail/util.rb
 - lib/logtail/util/non_nil_hash_builder.rb
 - lib/logtail/version.rb
-- logtail-ruby.gemspec
+- logtail.gemspec
 - spec/README.md
 - spec/logtail/current_context_spec.rb
 - spec/logtail/events/controller_call_spec.rb
@@ -219,10 +219,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Query logs like you query your database. https://logtail.com
+summary: This package has been deprecated. Please, switch to 'logtail' https://rubygems.org/gems/logtail
 test_files:
 - spec/README.md
 - spec/logtail/current_context_spec.rb