Merge pull request rails#49854 from skipkayhil/hm-document-aj-logger

Document ActiveJob::Base#logger and #log_arguments

Author: skipkayhil

activejob/lib/active_job/logging.rb

@@ -4,17 +4,31 @@
 require "active_support/logger"
 
 module ActiveJob
-  module Logging # :nodoc:
+  module Logging
     extend ActiveSupport::Concern
 
     included do
+      ##
+      # Accepts a logger conforming to the interface of Log4r or the default
+      # Ruby +Logger+ class. You can retrieve this logger by calling +logger+ on
+      # either an Active Job job class or an Active Job job instance.
       cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
+
+      ##
+      # Configures whether a job's arguments should be logged. This can be
+      # useful when a job's arguments may be sensitive and so should not be
+      # logged.
+      #
+      # The value defaults to +true+, but this can be configured with
+      # +config.active_job.log_arguments+. Additionally, individual jobs can
+      # also configure a value, which will apply to themselves and any
+      # subclasses.
       class_attribute :log_arguments, instance_accessor: false, default: true
 
       around_enqueue(prepend: true) { |_, block| tag_logger(&block) }
     end
 
-    def perform_now
+    def perform_now # :nodoc:
       tag_logger(self.class.name, self.job_id) { super }
     end