mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Tagged logging
This commit is contained in:
parent
e597867bb3
commit
6eb163a706
8 changed files with 132 additions and 25 deletions
|
@ -91,10 +91,6 @@ We currently have adapters for:
|
|||
* [Sneakers](https://github.com/jondot/sneakers)
|
||||
* [Sucker Punch](https://github.com/brandonhilkert/sucker_punch)
|
||||
|
||||
We would like to have adapters for:
|
||||
|
||||
* [Resque 2.x](https://github.com/resque/resque) (see [#7](https://github.com/rails/activejob/issues/7))
|
||||
|
||||
|
||||
## Under development as a gem, targeted for Rails inclusion
|
||||
|
||||
|
|
|
@ -2,8 +2,9 @@ require 'active_job/queue_adapter'
|
|||
require 'active_job/queue_name'
|
||||
require 'active_job/enqueuing'
|
||||
require 'active_job/execution'
|
||||
require 'active_job/logging'
|
||||
require 'active_job/callbacks'
|
||||
require 'active_job/identifier'
|
||||
require 'active_job/logging'
|
||||
|
||||
module ActiveJob
|
||||
class Base
|
||||
|
@ -13,6 +14,7 @@ module ActiveJob
|
|||
include Enqueuing
|
||||
include Execution
|
||||
include Callbacks
|
||||
include Identifier
|
||||
include Logging
|
||||
|
||||
ActiveSupport.run_load_hooks(:active_job, self)
|
||||
|
|
16
lib/active_job/identifier.rb
Normal file
16
lib/active_job/identifier.rb
Normal file
|
@ -0,0 +1,16 @@
|
|||
require 'active_job/arguments'
|
||||
|
||||
module ActiveJob
|
||||
module Identifier
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
included do
|
||||
attr_writer :job_id
|
||||
end
|
||||
|
||||
def job_id
|
||||
@job_id ||= SecureRandom.uuid
|
||||
end
|
||||
|
||||
end
|
||||
end
|
|
@ -3,26 +3,51 @@ require 'active_support/core_ext/string/filters'
|
|||
module ActiveJob
|
||||
module Logging
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
|
||||
included do
|
||||
cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
|
||||
|
||||
around_enqueue do |job, block, _|
|
||||
tag_logger do
|
||||
block.call
|
||||
end
|
||||
end
|
||||
|
||||
around_perform do |job, block, _|
|
||||
tag_logger(job.class.name, job.job_id) do
|
||||
payload = {adapter: job.class.queue_adapter, job: job.class, args: job.arguments}
|
||||
ActiveSupport::Notifications.instrument("perform_start.active_job", payload.dup)
|
||||
ActiveSupport::Notifications.instrument("perform.active_job", payload) do |payload|
|
||||
block.call
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
before_enqueue do |job|
|
||||
if job.enqueued_at
|
||||
ActiveSupport::Notifications.instrument "enqueue_at.active_job",
|
||||
ActiveSupport::Notifications.instrument "enqueue_at.active_job",
|
||||
adapter: job.class.queue_adapter, job: job.class, args: job.arguments, timestamp: job.enqueued_at
|
||||
else
|
||||
ActiveSupport::Notifications.instrument "enqueue.active_job",
|
||||
adapter: job.class.queue_adapter, job: job.class, args: job.arguments
|
||||
end
|
||||
end
|
||||
|
||||
before_perform do |job|
|
||||
ActiveSupport::Notifications.instrument "perform.active_job",
|
||||
adapter: job.class.queue_adapter, job: job.class, args: job.arguments
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
def tag_logger(*tags)
|
||||
if logger.respond_to?(:tagged)
|
||||
tags.unshift "ActiveJob" unless logger_tagged_by_active_job?
|
||||
ActiveJob::Base.logger.tagged(*tags){ yield }
|
||||
else
|
||||
yield
|
||||
end
|
||||
end
|
||||
|
||||
def logger_tagged_by_active_job?
|
||||
logger.formatter.current_tags.include?("ActiveJob")
|
||||
end
|
||||
|
||||
class LogSubscriber < ActiveSupport::LogSubscriber
|
||||
def enqueue(event)
|
||||
info "Enqueued #{event.payload[:job].name} to #{queue_name(event)}" + args_info(event)
|
||||
|
@ -32,10 +57,13 @@ module ActiveJob
|
|||
info "Enqueued #{event.payload[:job].name} to #{queue_name(event)} at #{enqueued_at(event)}" + args_info(event)
|
||||
end
|
||||
|
||||
def perform(event)
|
||||
info "Performed #{event.payload[:job].name} from #{queue_name(event)}" + args_info(event)
|
||||
def perform_start(event)
|
||||
info "Performing #{event.payload[:job].name} from #{queue_name(event)}" + args_info(event)
|
||||
end
|
||||
|
||||
def perform(event)
|
||||
info "Performed #{event.payload[:job].name} from #{queue_name(event)} in #{event.duration.round(2).to_s}ms"
|
||||
end
|
||||
|
||||
private
|
||||
def queue_name(event)
|
||||
|
@ -43,7 +71,7 @@ module ActiveJob
|
|||
end
|
||||
|
||||
def args_info(event)
|
||||
event.payload[:args].any? ? ": #{event.payload[:args].inspect}" : ""
|
||||
event.payload[:args].any? ? " with arguments: #{event.payload[:args].map(&:inspect).join(", ")}" : ""
|
||||
end
|
||||
|
||||
def enqueued_at(event)
|
||||
|
|
|
@ -4,11 +4,11 @@ require 'thread'
|
|||
module ActiveJob
|
||||
module QueueAdapters
|
||||
class SneakersAdapter
|
||||
@mutex = Mutex.new
|
||||
|
||||
@monitor = Monitor.new
|
||||
|
||||
class << self
|
||||
def enqueue(job, *args)
|
||||
@mutex.synchronize do
|
||||
@monitor.synchronize do
|
||||
JobWrapper.from_queue job.queue_name
|
||||
JobWrapper.enqueue [ job, *args ]
|
||||
end
|
||||
|
|
|
@ -1,15 +1,30 @@
|
|||
require 'helper'
|
||||
require "active_support/log_subscriber/test_helper"
|
||||
require 'jobs/logging_job'
|
||||
require 'jobs/nested_job'
|
||||
|
||||
class AdapterTest < ActiveSupport::TestCase
|
||||
include ActiveSupport::LogSubscriber::TestHelper
|
||||
include ActiveSupport::Logger::Severity
|
||||
|
||||
class TestLogger < ActiveSupport::Logger
|
||||
def initialize
|
||||
@file = StringIO.new
|
||||
super(@file)
|
||||
end
|
||||
|
||||
def messages
|
||||
@file.rewind
|
||||
@file.read
|
||||
end
|
||||
end
|
||||
|
||||
def setup
|
||||
super
|
||||
$BUFFER = []
|
||||
@old_logger = ActiveJob::Base.logger
|
||||
ActiveJob::Base.logger = @logger
|
||||
@logger = ActiveSupport::TaggedLogging.new(TestLogger.new)
|
||||
set_logger @logger
|
||||
ActiveJob::Logging::LogSubscriber.attach_to :active_job
|
||||
end
|
||||
|
||||
|
@ -23,26 +38,56 @@ class AdapterTest < ActiveSupport::TestCase
|
|||
ActiveJob::Base.logger = logger
|
||||
end
|
||||
|
||||
|
||||
def test_uses_active_job_as_tag
|
||||
HelloJob.enqueue "Cristian"
|
||||
assert_match(/\[ActiveJob\]/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_enqueue_job_logging
|
||||
HelloJob.enqueue "Cristian"
|
||||
assert_match(/Enqueued HelloJob to .*?:.*Cristian/, @logger.logged(:info).join)
|
||||
assert_match(/Enqueued HelloJob to .*?:.*Cristian/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_perform_job_logging
|
||||
HelloJob.enqueue "Cristian"
|
||||
assert_match(/Performed HelloJob from .*?:.*Cristian/, @logger.logged(:info).join)
|
||||
LoggingJob.enqueue "Dummy"
|
||||
assert_match(/Performing LoggingJob from .*? with arguments:.*Dummy/, @logger.messages)
|
||||
assert_match(/Dummy, here is it: Dummy/, @logger.messages)
|
||||
assert_match(/Performed LoggingJob from .*? in .*ms/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_perform_uses_job_name_job_logging
|
||||
LoggingJob.enqueue "Dummy"
|
||||
assert_match(/\[LoggingJob\]/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_perform_uses_job_id_job_logging
|
||||
LoggingJob.enqueue "Dummy"
|
||||
assert_match(/\[LOGGING-JOB-ID\]/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_perform_nested_jobs_logging
|
||||
NestedJob.enqueue
|
||||
assert_match(/\[LoggingJob\] \[.*?\]/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\] Enqueued NestedJob to/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Performing NestedJob from/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Enqueued LoggingJob to .* with arguments: "NestedJob"/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Performing LoggingJob from .* with arguments: "NestedJob"/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Dummy, here is it: NestedJob/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\].*\[LoggingJob\] \[LOGGING-JOB-ID\] Performed LoggingJob from .* in/, @logger.messages)
|
||||
assert_match(/\[ActiveJob\] \[NestedJob\] \[NESTED-JOB-ID\] Performed NestedJob from .* in/, @logger.messages)
|
||||
end
|
||||
|
||||
def test_enqueue_at_job_logging
|
||||
HelloJob.enqueue_at 1, "Cristian"
|
||||
assert_match(/Enqueued HelloJob to .*? at.*Cristian/, @logger.logged(:info).join)
|
||||
assert_match(/Enqueued HelloJob to .*? at.*Cristian/, @logger.messages)
|
||||
rescue NotImplementedError
|
||||
skip
|
||||
end
|
||||
|
||||
def test_enqueue_in_job_logging
|
||||
HelloJob.enqueue_in 2, "Cristian"
|
||||
assert_match(/Enqueued HelloJob to .*? at.*Cristian/, @logger.logged(:info).join)
|
||||
assert_match(/Enqueued HelloJob to .*? at.*Cristian/, @logger.messages)
|
||||
rescue NotImplementedError
|
||||
skip
|
||||
end
|
||||
|
|
10
test/jobs/logging_job.rb
Normal file
10
test/jobs/logging_job.rb
Normal file
|
@ -0,0 +1,10 @@
|
|||
class LoggingJob < ActiveJob::Base
|
||||
def perform(dummy)
|
||||
logger.info "Dummy, here is it: #{dummy}"
|
||||
end
|
||||
|
||||
def job_id
|
||||
"LOGGING-JOB-ID"
|
||||
end
|
||||
end
|
||||
|
10
test/jobs/nested_job.rb
Normal file
10
test/jobs/nested_job.rb
Normal file
|
@ -0,0 +1,10 @@
|
|||
class NestedJob < ActiveJob::Base
|
||||
def perform
|
||||
LoggingJob.enqueue "NestedJob"
|
||||
end
|
||||
|
||||
def job_id
|
||||
"NESTED-JOB-ID"
|
||||
end
|
||||
end
|
||||
|
Loading…
Reference in a new issue