researchable_loggable 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d31e14c3436ecf2f814d53dcd9eba0a1a5a8686cdf9d293473c46c8dab7fea85
-  data.tar.gz: 3ae484c57e691a6e9e2f95fd57cf50b83a21376cdceb58d7e99d3847e3b7f78f
+  metadata.gz: 4b80bc8fef9e875582f653226ef7bcc8f2bf01c44b7befba142694842800026f
+  data.tar.gz: 55cd5ef8ca78c68dd4e25ebc1cd7e68627f1871d4a2d0f646267a41ab8cab623
 SHA512:
-  metadata.gz: 2154157435a80a51f35f7adcd027f19350fde893d32be03a88bdbfc71929a1e7b96eff437e1c011fff7f6f85f6eac6811445b7dd86edfaed6d5bd5d55700625c
-  data.tar.gz: f21065f092442df36a47a3b7a52869d8c1cf3e74aad4ae9906f8b51e16786f7e7c5b25b548539ea930c899ef520a52ab13d77c5445d2eb30a3fc112639c4bff3
+  metadata.gz: 5f7821133b81bd0e363fea979048ef084e602860f83a558ed1d923b93f17950855dbc041ddc1eb314eeedfae03fdb8ed88319d4ea589439d4f8d5754c6ac86da
+  data.tar.gz: 1482b7dd44efb2a1177aabccd50f0f3ffb888e0af4448fc4ce27871ee93daf1648e745572f501a4770e42e7b571cd66c9088e7523d17534133362a2735a04dc9

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [1.4.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.3.1...v1.4.0) (2024-11-29)
+
+
+### Features
+
+* add trace and span id ([6e486e0](https://gitlab.com/researchable/general/gems/loggable/commit/6e486e03f7bef1ecf739195d80472f3cf3c2b7f6))
+* replace ecs logging format to logfmt ([19eb571](https://gitlab.com/researchable/general/gems/loggable/commit/19eb571719ed294fed4f94094c091c76470cae53))
+
+## [1.3.1](https://gitlab.com/researchable/general/gems/loggable/compare/v1.3.0...v1.3.1) (2024-11-26)
+
+
+### Bug Fixes
+
+* accessing method of undefined in lograge custom_option ([fb44b01](https://gitlab.com/researchable/general/gems/loggable/commit/fb44b01c305f4321a560f8824419abc5d1512874))
+
 # [1.3.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.2.0...v1.3.0) (2024-11-11)
 
 

data/Gemfile

@@ -11,7 +11,6 @@ gem 'rspec', '~> 3.0'
 
 gem 'ruboguide', '~> 1.0'
 
-gem 'ecs-logging', '~> 1.0'
 gem 'lograge'
 gem 'logstash-event'
 

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    researchable_loggable (1.2.0)
-      ecs-logging (~> 1.0)
+    researchable_loggable (1.3.1)
       lograge
       logstash-event
       opentelemetry-exporter-otlp (~> 0.28)
@@ -36,7 +35,6 @@ GEM
     concurrent-ruby (1.2.0)
     crass (1.0.6)
     diff-lcs (1.5.0)
-    ecs-logging (1.0.0)
     erubi (1.12.0)
     google-protobuf (4.27.4-x86_64-linux)
       bigdecimal
@@ -335,7 +333,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  ecs-logging (~> 1.0)
   lograge
   logstash-event
   opentelemetry-exporter-otlp (~> 0.28)

data/lib/loggable/logfmt/logger.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'time'
+require 'active_support/logger_silence'
+
+module Loggable
+  module Logfmt
+    # A structured logger that formats log messages in a key-value style using Logfmt formatting
+    # This has been adapted from https://github.com/cyberdelia/logfmt-ruby/
+    class Logger < ::Logger
+      def initialize(*args, **kwargs)
+        super
+        @formatter ||= KeyValueFormatter.new
+      end
+
+      # Include the LoggerSilence module to fix the incompatibility with ActiveSupport::LoggerSilence whe
+      # Rails.application.config.assets.quiet option is set to true, but do not include the module for the
+      # test environment as it causes issues with ActiveSupport::LoggerThreadSafeLevel::IsolatedExecutionState.
+      def self.include_logger_silence
+        include ActiveSupport::LoggerSilence
+      end
+
+      # Custom formatter class that renders logs as in a key-value style using Logfmt formatting
+      class KeyValueFormatter < ::Logger::Formatter
+        def call(severity, timestamp, progname, msg)
+          %(time=#{datetime(timestamp)} severity=#{severity.ljust(5)}#{progname(progname)} #{message(msg)}\n)
+        end
+
+        private
+
+        def datetime(time)
+          time.utc.iso8601(3)
+        end
+
+        def message(msg)
+          return unless msg
+
+          if msg.respond_to?(:to_hash)
+            pairs = msg.to_hash.map { |k, v| format_pair(k, v) }
+            pairs.compact.join(' ')
+          else
+            format_pair('message', msg)
+          end
+        end
+
+        def format_pair(key, value)
+          return nil if value.nil?
+
+          # Return a bare key when the value is a `TrueClass`
+          return key if value == true
+
+          "#{key}=#{format_value(value)}"
+        end
+
+        def progname(progname)
+          return nil unless progname
+
+          # Format this pair like any other to ensure quoting, escaping, etc…,
+          # But we also need a leading space so we can interpolate the resulting
+          # key/value pair into our log line.
+          " #{format_pair(' progname', progname)}"
+        end
+
+        def format_value(value)
+          if value.is_a?(Float)
+            format('%.3f', value)
+          elsif value.is_a?(Time)
+            datetime(value)
+          elsif value.respond_to?(:to_ary)
+            format_value(
+              "[#{Array(value).map { |v| format_value(v) }.join(', ')}]"
+            )
+          else
+            # Interpolating due to a weird/subtle behaviour possible in #to_s.
+            # Namely, it's possible it doesn't actually return a String:
+            # https://github.com/ruby/spec/blob/3affe1e54fcd11918a242ad5d4a7ba895ee30c4c/language/string_spec.rb#L130-L141
+            value = "#{value}" # rubocop:disable Style/RedundantInterpolation
+            value = value.dump if value.match?(/[[:space:]]|[[:cntrl:]]/) # wrap in quotes and escape control characters
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/loggable/railtie.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'ecs_logging/logger'
+require 'lograge'
 require 'rails'
+require 'opentelemetry/sdk'
 
 module Loggable
   # Railtie to configure logging before rails starts
@@ -12,13 +13,14 @@ module Loggable
     config.loggable.current_user_method = :current_user
 
     # Initializer runs before initialize_logger (found in Bootstrap) so from the very beginning we are logging using
-    # the ecs format, even during the initialization process
+    # the logfmt format, even during the initialization process
     # rubocop:disable Metrics/BlockLength
     initializer :loggable_web, before: :initialize_logger do
       Rails.application.configure do
         production_like = Rails.env.production? || config.loggable.production_like
         if production_like
-          Rails.logger = ::EcsLogging::Logger.new($stdout)
+          Loggable::Logfmt::Logger.include_logger_silence if Rails.application.config.assets.quiet
+          Rails.logger = Loggable::Logfmt::Logger.new($stdout)
           Rails.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
 
           Loggable::OpenTelemetryConfig.configure(Rails.application.class.module_parent_name.underscore.dasherize)
@@ -32,20 +34,26 @@ module Loggable
           if controller.respond_to?(config.loggable.current_user_method)
             user_id = controller.send(config.loggable.current_user_method).try(:id)
           end
+
           {
-            ecs: {
-              'source.ip': controller.request.ip,
-              'user.id': user_id,
-              'http.code': response_code
-            },
-            status: response_code
+            'source.ip': controller.request.ip,
+            'user.id': user_id,
+            status: response_code,
+            span_id: OpenTelemetry::Trace.current_span.context.hex_span_id,
+            trace_id: OpenTelemetry::Trace.current_span.context.hex_trace_id
           }
         end
         config.lograge.custom_options = lambda do |event|
+          return if event.payload[:params].blank?
+
           exceptions = %w[controller action format id]
-          { params: event.payload[:params].except(*exceptions) }
+          params = event.payload[:params].except(*exceptions)
+          # append a suffix to each param
+          params.each_with_object({}) do |(key, value), result|
+            result["params.#{key}"] = value
+          end
         end
-        config.lograge.formatter = Loggable::Lograge::Formatter.new if production_like
+        config.lograge.formatter = ::Lograge::Formatters::Raw.new
       end
     end
     # rubocop:enable Metrics/BlockLength
@@ -54,7 +62,7 @@ module Loggable
       Rails.application.configure do
         if defined?(Delayed::Worker)
           if Rails.env.production? || config.loggable.production_like
-            Delayed::Worker.logger = ::EcsLogging::Logger.new($stdout)
+            Delayed::Worker.logger = Loggable::Logfmt::Logger.new($stdout)
             Delayed::Worker.logger.level = ActiveSupport::Logger.const_get(config.log_level.to_s.upcase || 'INFO')
             Loggable::OpenTelemetryConfig.configure("#{Rails.application.class.module_parent_name.underscore.dasherize}
                                                     -worker")

data/lib/loggable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loggable
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/lib/researchable_loggable.rb

@@ -3,8 +3,7 @@
 require_relative 'loggable/version'
 require_relative 'loggable/railtie' if defined?(Rails::Railtie)
 require_relative 'loggable/opentelemetry_config'
-require_relative 'loggable/ecs_logging/formatter_monkey_patch'
-require_relative 'loggable/lograge/formatter'
+require_relative 'loggable/logfmt/logger'
 
 module ResearchableLoggable
   class Error < StandardError

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: researchable_loggable
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ecs-logging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement
@@ -114,20 +100,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/loggable/ecs_logging/formatter_monkey_patch.rb
-- lib/loggable/lograge/formatter.rb
+- lib/loggable/logfmt/logger.rb
 - lib/loggable/opentelemetry_config.rb
 - lib/loggable/railtie.rb
 - lib/loggable/version.rb
 - lib/researchable_loggable.rb
 - sig/loggable.rbs
-homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.3.0/README.md
+homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.4.0/README.md
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.3.0/README.md
+  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.4.0/README.md
   source_code_uri: https://gitlab.com/researchable/general/gems/loggable
-  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.3.0/CHANGELOG.md
+  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.4.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -143,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Researchable's gem to standardize logging on all Rails applications.

data/lib/loggable/ecs_logging/formatter_monkey_patch.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'ecs_logging/formatter'
-
-module Loggable
-  module EcsLogging
-    # A monkey patch to the ::EcsLogging::Formatter to customize how messages from lograge are rendered
-    module FormatterMonkeyPatch
-      def call(severity, time, progname, msg, **extras)
-        base = {
-          '@timestamp': time.utc.iso8601(3),
-          'log.level': severity,
-          message: msg,
-          'ecs.version': '1.4.0'
-        }
-
-        base['log.logger'] = progname if progname
-
-        base.merge!(msg.except(:lograge)) if msg.is_a?(Hash) && msg.key?(:lograge)
-        base.merge!(extras) if extras
-
-        "#{JSON.fast_generate(base)}\n"
-      end
-
-      class << self
-        def apply_patch
-          const = find_const
-          mtd = find_method(const)
-
-          # byebug
-          const.prepend(self) if const && mtd && mtd.arity == -5
-        end
-
-        private
-
-        def find_const
-          Kernel.const_get('::EcsLogging::Formatter')
-        rescue NameError
-          puts '[WARN] ::EcsLogging::Formatter not found. Patch could not be applied.' # rubocop:disable Rails/Output
-        end
-
-        def find_method(const)
-          return unless const
-
-          method_name = :call
-          const.instance_method(method_name)
-        rescue NameError
-          puts "[WARN] '#{method_name}' method not found in '#{const}'. Patch could not be applied." # rubocop:disable Rails/Output
-        end
-      end
-    end
-  end
-end
-
-Loggable::EcsLogging::FormatterMonkeyPatch.apply_patch

data/lib/loggable/lograge/formatter.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'lograge'
-require 'active_support/core_ext/array'
-
-module Loggable
-  module Lograge
-    # Custom formatter class that renders logs as ruby objects with just the ecs fields generated by the logger, the
-    # message, and a lograge flag so the ECS logger knows to process this further before rendering
-    class Formatter < ::Lograge::Formatters::KeyValue
-      def call(data)
-        (data[:ecs] || {}).merge(message: super(data), lograge: true)
-      end
-
-      protected
-
-      def fields_to_display(data)
-        data.keys.excluding(%i[ecs])
-      end
-    end
-  end
-end