ContextualizedLogs

class MyController < ApplicationController
  include ContextualizedLogs::ContextualizedController
end

class User < ActiveRecord::Base
  include ContextualizedLogs::ContextualizedModel
  contextualizable { user_ids: :id }
end

class UserController < ApplicationController
  include ContextualizedLogs::ContextualizedController
  contextualize_model true

  def show
    User.find(params[:id])
  end
end

class User < ActiveRecord::Base
  include ContextualizedLogs::ContextualizedModel
  contextualizable { user_ids: :id }
end

class UserTracker < ActiveRecord::Base
  include ContextualizedLogs::ContextualizedModel

  belongs_to :user

  contextualizable { user_tracker_ids: :id }
end

class UserController < ApplicationController
  include ContextualizedLogs::ContextualizedController
  contextualize_model true

  def show
    user_id = params[:id]
    User.find(user_id)
    UserTrackerWorker.perform_async(user_id, 'show')
  end
end

class UserTrackerWorker
  include Sidekiq::Worker
  include ContextualizedLogs::ContextualizedWorker
  contextualize_worker true
  contextualize_model true
  def self.contextualize_args(args)
    { user_id: args.first, action: args.last }
  end

  def perform(user_id, action)
    UserTracker.create(user_id: user_id, action: action)
  end
end

Rails.application.configure do
  config.logger = ContextualizedLogs::ContextualizedLogger.new("log/#{Rails.env}.log")
end

class Controller < ApplicationController
  include ContextualizedLogs::ContextualizedController
end

class Model < ActiveRecord::Base
  include ContextualizedLogs::ContextualizedModel

  # cherry picking which model value/column should be added to CurrentContext metadata
  contextualizable keys: {model_ids: :id}
end

class Worker
  include ContextualizedLogs::ContextualizedWorker
  contextualize_worker true # enable logging of job enqueuing, performing, completing and failure
  contextualize_model true # enable logging of any (contextualized) model found or created while performing job

  # enable adding jobs args (cherry picked) to log metadata (CurrentContext) to be logged alongs any job logs
  def self.contextualize_args(args)
    { first: args.first }
  end
end

# config/initializers/contextualized_logs.rb
require 'contextualized_logs'

module ContextualizedLogs
  configure do |config|
    # enable logging of contextualized model values in all (contextualized) controller by default
    # can be manually enabled on each controller otherwise (contextualize_model true)
    config.controller_default_contextualize_model = true # default: false
    # enable logging of worker enqueing/performing/completing/[failure] in all (contextualized) worker by default
    # can be manually enabled on each worker otherwise (contextualize_worker true)
    config.worker_default_contextualize_worker = true # default: true
    # enable logging of contextualized model values in all (contextualized) worker by default
    # can be manually enabled on each worker otherwise (contextualize_model true)
    config.worker_default_contextualize_model = true # default: false
    # customize logs at Logger level (not in context of a controller request or worker job)
    config.log_formatter = proc do |severity, timestamp, progname, msg|
      # call the default formatter
      log = ContextualizedLogger.default_formatter.call(severity, timestamp, progname, msg)
      # enhance log with Datadog APM trace correlation
      log = JSON.parse(log)
      datadog_correlation = Datadog.tracer.active_correlation
      log.merge!(
        dd: {
          trace_id: datadog_correlation.trace_id,
          span_id: datadog_correlation.span_id
        },
        ddsource: ['ruby']
      )
      # add your own log
      log.merge!(
        my_custom_log_value: 'my_custom_log_value'
      )
      log.to_json + "\n"
    end
    # customize logs extracted from controller (ie: request, ...)
    config.controller_default_contextualizer = proc do |controller|
      # call the default request logging
      ContextualizedController.contextualize_request(controller)
      if controller.current_user
        ContextualizedController.current_context.attributes.merge!(
          usr: {
            id: controller.current_user.id
          }
        )
      end
    end
  end
end

gem 'contextualized_logs'