researchable_loggable 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ac4f81b15d9f88b44cd0e358fdf9ed04734a512900fdb859ce9cb87a470aaa
-  data.tar.gz: 8ba8d690974a6b46fd41271f4c912982536df60726f9ba22fb4696e2f19923bb
+  metadata.gz: 2005d7d174fbe9815687b94b4960961860d6b3a63ea445e01bc7cdaa8af8acfa
+  data.tar.gz: 9cd24968d9a82efaf1442acfeb4aa2aaf41f0634fe302c8297cccf13c2bc78fd
 SHA512:
-  metadata.gz: d1f27347e3330fd2354d91546b943687a1ad8d4ee7cef1fcb532e0937bed62291ec8b2445dd60f8ab5cc25fb7ba3e76cc9f373b4d9bbafdb1855b552f4fd04bf
-  data.tar.gz: accd88f616138d0a66e1a434b543f574f37eba588edac1a135f853777945613988ccc5b5449a38cae418fc55c5efcc733c2105760136ddb0e2758ca3f7ce1dfc
+  metadata.gz: cd4baf5861bfc5acb9b0ebcbb0636691f698b51fb78b917cd00b5a39ddeafb558c9f7fd3f385b03f8d7ba6aac6af75360dbbdbd52019c1d052a4843cbaee28d5
+  data.tar.gz: 47b75545f83e0a1ad52a6ab80a480b369a706758b1f4844a10d0165ca04b223780bcd9f60b36430eb69fc06cedaaf612cf0782be4b1e3e4bc4c0a8e03b9e371a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.6.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.5.1...v1.6.0) (2025-01-15)
+
+
+### Features
+
+* **logging:** add request.id, file, and line to log payload ([f3db220](https://gitlab.com/researchable/general/gems/loggable/commit/f3db2209b6046aa6ce6ab9f0f052d9316b4508b9))
+
 ## [1.5.1](https://gitlab.com/researchable/general/gems/loggable/compare/v1.5.0...v1.5.1) (2024-12-05)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    researchable_loggable (1.3.1)
+    researchable_loggable (1.5.1)
       lograge
       logstash-event
       opentelemetry-exporter-otlp (~> 0.28)

data/lib/loggable/logfmt/logger.rb

@@ -24,7 +24,13 @@ module Loggable
       # 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)
+          file, line = extract_caller_info
+          file = relative_to_rails_root(file)
+
+          file_info = format_tag('file', file)
+          line_info = format_tag('line', line)
+
+          %(time=#{datetime(timestamp)} severity=#{severity.ljust(5)}#{file_info}#{line_info}#{progname(progname)} #{message(msg)}\n) # rubocop:disable Layout/LineLength
         end
 
         private
@@ -80,6 +86,47 @@ module Loggable
             value
           end
         end
+
+        # Extracts caller information (file and line number) for the log message
+        def extract_caller_info
+          caller_locations.each do |loc|
+            # Skip frames that are part of internal or irrelevant paths (gems, vendor, etc.)
+            next if internal_frame?(loc.path)
+
+            # Return the first relevant application-level frame
+            return [loc.path, loc.lineno]
+          end
+
+          # Fallback if no relevant frame is found
+          %w[unknown unknown]
+        end
+
+        # Determines if a given file path corresponds to an internal or excluded frame
+        def internal_frame?(path)
+          excluded_patterns = %w[
+            /gems/
+            /vendor/
+            <internal:kernel>
+            loggable
+          ].freeze
+
+          excluded_patterns.any? { |pattern| path.include?(pattern) }
+        end
+
+        # Converts an absolute file path to a path relative to Rails.root
+        # If the path is outside of Rails.root, it returns the original path
+        def relative_to_rails_root(path)
+          rails_root = defined?(Rails) ? Rails.root.to_s : ''
+          path.start_with?(rails_root) ? path.sub(%r{^#{rails_root}/}, '') : path
+        end
+
+        # Formats a key-value tag for log output
+        # If the value is 'unknown', it returns an empty string to omit the tag
+        def format_tag(key, value)
+          return '' if value == 'unknown'
+
+          " #{key}=#{value}"
+        end
       end
     end
   end

data/lib/loggable/railtie.rb

@@ -37,9 +37,15 @@ module Loggable
             user_id = controller.send(config.loggable.current_user_method).try(:id)
           end
 
+          # Look for the request ID in headers
+          request_id = controller.request.headers['X-Request-ID'] ||  # Check for a custom request ID header
+                       controller.request.headers['traceparent'] ||   # Check for the W3C Trace Context header
+                       controller.request.env['HTTP_X_REQUEST_ID']    # Fallback to Rack's normalized header
+
           {
             'source.ip': controller.request.ip,
             'user.id': user_id,
+            'request.id': request_id,
             status: response_code,
             span_id: OpenTelemetry::Trace.current_span.context.hex_span_id,
             trace_id: OpenTelemetry::Trace.current_span.context.hex_trace_id

data/lib/loggable/version.rb

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

data/node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestGem
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: researchable_loggable
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -109,13 +109,13 @@ files:
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/prerelease/lib/test-gem/version.rb
 - node_modules/semantic-release-rubygem/src/__tests__/fixtures/valid/lib/test-gem/version.rb
 - sig/loggable.rbs
-homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.5.1/README.md
+homepage: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.6.0/README.md
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.5.1/README.md
+  homepage_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.6.0/README.md
   source_code_uri: https://gitlab.com/researchable/general/gems/loggable
-  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.5.1/CHANGELOG.md
+  changelog_uri: https://gitlab.com/researchable/general/gems/loggable/-/blob/v1.6.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: