researchable_loggable 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ac4f81b15d9f88b44cd0e358fdf9ed04734a512900fdb859ce9cb87a470aaa
-  data.tar.gz: 8ba8d690974a6b46fd41271f4c912982536df60726f9ba22fb4696e2f19923bb
+  metadata.gz: 26d7a5d5e93a66cb06484a698b260df9ac1867adef2dbb61085a9f420881da2e
+  data.tar.gz: 0b59c63f4400c28f3c1f562928f42d3a2de4c458248744ae265149079d310294
 SHA512:
-  metadata.gz: d1f27347e3330fd2354d91546b943687a1ad8d4ee7cef1fcb532e0937bed62291ec8b2445dd60f8ab5cc25fb7ba3e76cc9f373b4d9bbafdb1855b552f4fd04bf
-  data.tar.gz: accd88f616138d0a66e1a434b543f574f37eba588edac1a135f853777945613988ccc5b5449a38cae418fc55c5efcc733c2105760136ddb0e2758ca3f7ce1dfc
+  metadata.gz: a0b20c2fdae4e7cc063453d3e225bdfcb4049e4253c203f40a517c5d08679f0dd1233f5d4a1bf2ea84235a6cca70689e6d92189ed87fb6aafb4041ec68566dab
+  data.tar.gz: d9ddd309f6d6e38af84acf6aad3854e27519be1af7aaa6f3539dc1c736c0ae7520ba9af3557948e3db75176d09efdf29d8265afa4f68e6c853d4838b35f10fe6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.7.0](https://gitlab.com/researchable/general/gems/loggable/compare/v1.6.0...v1.7.0) (2025-02-27)
+
+
+### Features
+
+* add disable_open_telemetry option ([7aa227b](https://gitlab.com/researchable/general/gems/loggable/commit/7aa227b4d0c4cc5392660581e541da0e408c0619))
+
+# [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/README.md

@@ -30,12 +30,12 @@ readable form. Development logs remain unaffected (see [Usage](#usage) for more
 
 ## How it works
 Loggable is a Railtie that overrides the default rails logger configuration. Right from the initialization process, the
-logger is set to `::EcsLogging::Logger` and the default log level is set to `INFO` (this can be overridden in 
-application.rb or your environment configuration). It also configures lograge automatically. Note that the 
+logger is set to `::EcsLogging::Logger` and the default log level is set to `INFO` (this can be overridden in
+application.rb or your environment configuration). It also configures lograge automatically. Note that the
 base_controller_class is set to `'ApplicationController'`. All your controllers should extend from this class.
 
 By default lograge and ::EcsLogging::Logger are not mutually compatible. The ECS formatter will try to render the output
-of lograge as the message, however some of the fields in the lograge output are metadata. To fix this, this gem uses a 
+of lograge as the message, however some of the fields in the lograge output are metadata. To fix this, this gem uses a
 monkey patch on the ECS gem that flattens the lograge output onto the Ecs object.
 
 ## Installation
@@ -65,11 +65,11 @@ gem will automatically configure the Rails logger and lograge to follow the Rese
 ### Parameters
 This are the parameters that can be configured in the `config.loggable` namespace:
 
-`production_like`. By default loggable will only 
-modify how the logs look on production. This is because the format that this gem enforces is slightly less 
-human readable (in favour of machine readability and compatibility with the Elastic Common Schema) than the default 
+`production_like`. By default loggable will only
+modify how the logs look on production. This is because the format that this gem enforces is slightly less
+human readable (in favour of machine readability and compatibility with the Elastic Common Schema) than the default
 Rails one. For development, the more human readable format is preferred. However, if you want to override this and
-log in the production format while on development (e.g. because you are troubleshooting a problem with the logs or you 
+log in the production format while on development (e.g. because you are troubleshooting a problem with the logs or you
 are developing against this gem) then you may add the following to your `config/environment/development.rb` file:
 ```ruby
 config.loggable.production_like = true
@@ -81,17 +81,22 @@ config.loggable.current_user_method = :my_current_user_method
 ```
 This method is used for ECS logging, if the method is not found, the user.id field will be set to nil.
 
+`disable_open_telemetry`. By default, loggable will try to inject the open telemetry trace ids into the log line. If you want to disable this, you may add the following to your `config/application.rb` file:
+```ruby
+config.loggable.disable_open_telemetry = true
+```
+
 No other configuration options are provided because this gem seeks to enforce consistency across all applications.
 
 For applications that already had some level of log customization, some cleanup might be needed:
 
-1. If lograge was added to the Gemfile already, it may be removed. Loggable relies on lograge internally, and will 
+1. If lograge was added to the Gemfile already, it may be removed. Loggable relies on lograge internally, and will
    make it available to the Rails application.
 2. Consequently, remove `config/lograge.rb` and all lograge related configuration.
-3. Remove all existing log configuration, specially for production environments. Places to look for this 
-   configuration are `config/application.rb` and `config/environment/production.rb`. If you chose to enable 
-   `production_like` mode on your development environment, you might also want to cleanup 
-   `config/environment/development.rb`. Things to look for when cleaning up are statements like `config.logger` and 
+3. Remove all existing log configuration, specially for production environments. Places to look for this
+   configuration are `config/application.rb` and `config/environment/production.rb`. If you chose to enable
+   `production_like` mode on your development environment, you might also want to cleanup
+   `config/environment/development.rb`. Things to look for when cleaning up are statements like `config.logger` and
    `config.log_formatter` and anything with the word `log` or `logger` in it.
 
 ## Development

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

@@ -18,6 +18,8 @@ module Loggable
     initializer :loggable_web, before: :initialize_logger do
       Rails.application.configure do
         production_like = Rails.env.production? || config.loggable.production_like
+        disable_open_telemetry = config.loggable.disable_open_telemetry
+
         if production_like
           if Rails.application.config.respond_to?(:assets) && Rails.application.config.assets.quiet
             Loggable::Logfmt::Logger.include_logger_silence
@@ -25,7 +27,9 @@ module Loggable
           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)
+          unless disable_open_telemetry
+            Loggable::OpenTelemetryConfig.configure(Rails.application.class.module_parent_name.underscore.dasherize)
+          end
         end
 
         # lograge configuration
@@ -37,13 +41,22 @@ 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
+
+          payload = {
             '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
+            'request.id': request_id,
+            status: response_code
           }
+          if production_like && !disable_open_telemetry
+            payload[:span_id] = OpenTelemetry::Trace.current_span.context.hex_span_id
+            payload[:trace_id] = OpenTelemetry::Trace.current_span.context.hex_trace_id
+          end
+          payload
         end
         config.lograge.custom_options = lambda do |event|
           return if event.payload[:params].blank?
@@ -66,8 +79,10 @@ module Loggable
           if Rails.env.production? || config.loggable.production_like
             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")
+            unless config.loggable.disable_open_telemetry
+              worker_name = "#{Rails.application.class.module_parent_name.underscore.dasherize}-worker"
+              Loggable::OpenTelemetryConfig.configure(worker_name)
+            end
           else
             Delayed::Worker.logger = Logger.new($stdout)
             Delayed::Worker.logger.level = Logger::DEBUG

data/lib/loggable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loggable
-  VERSION = '1.5.1'
+  VERSION = '1.7.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.7.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.7.0
 platform: ruby
 authors:
 - Researchable
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-02-27 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.7.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.7.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.7.0/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: