Skip to content

Add opt-in sidekiq extension for annotating delayed classes #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add opt-in sidekiq extension for annotating delayed classes #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion lib/marginalia/sidekiq_instrumentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,28 @@ def call(worker, msg, queue)
end
end

def self.enable!
def self.enable!(annotate_delayed_class_extension: false)
if annotate_delayed_class_extension
Sidekiq::Extensions::DelayedClass.class_eval do
# NOTE: Prefer redefining perform so that YAML is only parsed once.
# Adding a Marginalia::Comment.components would incur an extra parsing on every query
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you have an example of an alternative to what was done here, but using the Marginalia::Comment.components mechanism that's documented to show this as a custom component?

I'm hunting for custom component examples.

# in a delayed class
def perform(yml)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bf4 Do you have a shareable sample or example Yaml block that would be used as the input here? Is this a Sidekiq thing that has serialized values for target, method_name, and args?

(target, method_name, args) = YAML.load(yml)
annotation_context = marginalia_annotate_perform(target, method_name, args)
Marginalia.with_annotation(annotation_context) do
target.__send__(method_name, *args)
end
end

# NOTE: Hook is called before perform is executed and may have
# other side-effects
# @return [String] annotation_context
def marginalia_annotate_perform(target, method_name, args)
"#{target}.#{method_name}"
end
end
end
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
chain.add Marginalia::SidekiqInstrumentation::Middleware
Expand Down