contextualized_logs 0.0.2.pre.alpha → 0.0.3.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d2a30eaa931eb9013ce4e8007229c24f71150d89d7399372820eb33e1e72deb
-  data.tar.gz: 1b7a809fb3ea83334a7248a97a63c9728b899400c8e5869d7be28a55379fc832
+  metadata.gz: c8025983ccba69c3acd120ac1e5f37142f658d3139353d42757435d2b99ecd9c
+  data.tar.gz: 2be16ecff77a93ee9460dea3e95a76c195f1a1db4f5994c950c5d0b2ad11e90c
 SHA512:
-  metadata.gz: d1543991e0904103f8bd6dbf0fc791fa6fe6f8302aea6e49049ae49adbf35d352d5d226fc7075f48bbc956b9d7a2b7f7f136e0b9e980cd00a03be47658070552
-  data.tar.gz: 99b5866d81903a8bb4e7e3231acdd15931de535bb8297a2a6bd60c9c5ec9d7b397194b0f44f1f7e48ce9554962ab3a2174815033d736f6d4392d6ba89f4f517b
+  metadata.gz: 01f9f4e901e80a95c1ce9f04aef20f6438261af9e9ac17fb8e29ee63e3341de5da50189dd3353625281a28fb53271f96d9dd360ec675b75e1c3072687f24440a
+  data.tar.gz: 4a95d1831a58274b5e094e64f1bedc88584ba774d073831cdd08d6b457d9216f51f1cc0e199e4a2f47d46a3b0a0e1a5e7d3e38ed064a9937a3a4f249a7955901

data/config/environments/development.rb

@@ -59,4 +59,5 @@ Rails.application.configure do
   # routes, locales, etc. This feature depends on the listen gem.
   config.file_watcher = ActiveSupport::EventedFileUpdateChecker
   config.logger = ContextualizedLogs::ContextualizedLogger.new("log/#{Rails.env}.log")
+  config.logger.level = :info
 end

data/config/initializers/contextualized_logs.rb

@@ -8,13 +8,16 @@ module ContextualizedLogs
       log = JSON.parse(log)
       # set log <> APM trace correlation
       datadog_correlation = Datadog.tracer.active_correlation
-      log.merge(
+      log.merge!(
         dd: {
           trace_id: datadog_correlation.trace_id,
           span_id: datadog_correlation.span_id
         },
         ddsource: ['ruby']
-      ).to_json + "\n"
+      )
+      log.to_json + "\n"
+      # for local debug, dump log in JSON pretty format
+      # JSON.pretty_generate(log) + "\n"
     end
     config.controller_default_contextualizer = proc do |controller|
       ContextualizedController.default_contextualize_request(controller)

data/config/initializers/lograge.rb

@@ -0,0 +1,67 @@
+return if Rails.env.test?
+
+require 'lograge/sql/extension'
+require 'json'
+
+# pretty
+module Lograge
+  module Formatters
+    class PrettyJson
+      def call(data)
+        JSON.pretty_generate(data)
+      end
+    end
+  end
+end
+
+
+Rails.application.configure do
+  # Lograge (format log for datadog)
+  # https://docs.datadoghq.com/logs/log_collection/ruby/
+  # Lograge config
+  config.lograge.enabled = true
+  config.colorize_logging = false
+  # We are asking here to log in RAW (which are actually ruby hashes). The Ruby logging is going to take care of the JSON formatting.
+  config.lograge.formatter = Lograge::Formatters::Json.new
+  # for local debug, dump log in JSON pretty format
+  # config.lograge.formatter = Lograge::Formatters::PrettyJson.new
+  # keep existing log
+  config.lograge.keep_original_rails_log = false
+  # issue with existing rails logger and prefixing.. logging to different file
+  # Logger::SimpleFormatter?
+  config.lograge.logger = ActiveSupport::Logger.new("#{Rails.root}/log/#{Rails.env}.log")
+
+  config.lograge.custom_options = lambda do |event|
+    data = {}
+    if (exception = event.payload[:exception_object])
+      data = {
+        # datadog naming convention
+        # https://docs.datadoghq.com/logs/processing/attributes_naming_convention/#source-code
+        error: {
+          message: exception.message,
+          kind: exception.class.to_s,
+          stack: (exception.backtrace || []).join("; ")
+        }
+      }
+    end
+    correlation = Datadog.tracer.active_correlation
+    data.deep_merge!(
+      # Adds IDs as tags to log output
+      # trace injection to correlation APM with Rails logs
+      # https://docs.datadoghq.com/tracing/advanced/connect_logs_and_traces/?tab=ruby
+      log_type: 'request',
+      dd: {
+        trace_id: correlation.trace_id,
+        span_id: correlation.span_id
+      },
+      ddsource: ['ruby'],
+      syslog: { env: Rails.env, host: Socket.gethostname },
+      params: event.payload[:params].except(*Rails.application.config.filter_parameters) # ⚠️⚠️⚠️ check `config/initializers/filter_parameter_logging.rb`
+    )
+    data.deep_merge!(ContextualizedLogs.current_context.context) # merge current request context
+
+    # add all job's id (not merged by current context, add it only to rquest log)
+    data[:jobs] = ContextualizedLogs.current_context.enqueued_jobs_ids unless ContextualizedLogs.current_context.enqueued_jobs_ids.nil?
+    data
+  end
+end

data/lib/contextualized_logs.rb

@@ -17,6 +17,10 @@ module ContextualizedLogs
       @config || Config.default
     end
 
+    def current_context
+      config.current_context
+    end
+
     def configure(&block)
       config = Config.default
       block.call(config)

data/lib/contextualized_logs/contextualized_logger.rb

@@ -13,26 +13,18 @@ module ContextualizedLogs
       def current_context
         @current_context || ContextualizedLogs.config.current_context
       end
-      
+
       def default_formatter
         proc do |severity, timestamp, progname, msg|
-          # format (and enrich) log in JSON format (-> )
-          # https://docs.hq.com/logs/processing/attributes_naming_convention/#source-code
-          # correlation = Datadog.tracer.active_correlation
           data = {
-            # dd: {
-            #   trace_id: correlation.trace_id,
-            #   span_id: correlation.span_id
-            # },
-            # ddsource: ['ruby'],
             syslog: { env: Rails.env, host: Socket.gethostname },
             type: severity.to_s,
             time: timestamp
           }
-          data[:stack] = Kernel.caller.
-            map { |caller| caller.gsub(/#{Rails.root}/, '') }.
-            reject { |caller| caller.start_with?('/usr/local') || caller.include?('/shared/bundle/') || caller.start_with?('/Users/') }.
-            first(15)
+          # data[:stack] = Kernel.caller.
+          #   map { |caller| caller.gsub(/#{Rails.root}/, '') }.
+          #   reject { |caller| caller.start_with?('/usr/local') || caller.include?('/shared/bundle/') || caller.start_with?('/Users/') }.
+          #   first(15)
           data[:log_type] = 'log'
           data.merge!(parse_msg(msg)) # parse message (string, hash, error, ...)
           data.merge!(current_context.context) # merge current request context

data/lib/contextualized_logs/sidekiq/middleware/client/inject_current_context.rb

@@ -26,7 +26,7 @@ module ContextualizedLogs
               if worker_klass.contextualize_worker_enabled
                 job['context'] = current_context.to_json
                 Rails.logger.info "sidekiq: enqueing job #{worker_class}: #{job['jid']}, on queue: #{queue}"
-                Rails.logger.dump('Injecting context', JSON.parse(current_context.to_json), :debug)
+                # Rails.logger.dump('Injecting context', JSON.parse(current_context.to_json), :debug)
               end
             end
             yield

data/lib/contextualized_logs/version.rb

@@ -1,3 +1,3 @@
 module ContextualizedLogs
-  VERSION = '0.0.2-alpha'
+  VERSION = '0.0.3-alpha'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contextualized_logs
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre.alpha
+  version: 0.0.3.pre.alpha
 platform: ruby
 authors:
 - Hugues Bernet-Rollande
@@ -74,6 +74,7 @@ files:
 - config/initializers/datadog.rb
 - config/initializers/filter_parameter_logging.rb
 - config/initializers/inflections.rb
+- config/initializers/lograge.rb
 - config/initializers/mime_types.rb
 - config/initializers/sidekiq.rb
 - config/initializers/wrap_parameters.rb