Backport "[PROF-9650] Enable endpoint profiling for Sidekiq and similar background job processors" to 1.x-stable #3619
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This simplifies a bit the `trace_identifiers_for` and centralizes the logic for collecting or not the resource.
…und job processors
**What does this PR do?**
We have an opt-in list for which kinds of traces we collect the
resource from; this PR extends that list with the `worker` type
used by background consumers such as Sidekiq.
**Motivation:**
Enable profiling for Sidekiq and similar background job processors.
**Additional Notes:**
We also collect a few Sidekiq internal things (such as
`sidekiq.job_fetch`, `sidekiq.scheduled_poller_wait`,
`sidekiq.scheduled_push`, `sidekiq.stop` and `sidekiq.heartbeat`).
We discussed if it would make sense to hide them or not, but for now
we decided to still show them.
**How to test the change?**
This change includes test coverage; I also booted up sidekiq and tested
manually using the following script:
```ruby
# Running redis:
# * `docker-compose up redis`
# Running server:
# * `DD_SERVICE=sidekiq-testing DD_ENV=staging DD_PROFILING_ENABLED=true bundle exec sidekiq -r ./sidekiq.rb`
# Running client:
# * `DD_TRACE_ENABLED=false DD_TRACING_ENABLED=false be ddprofrb exec irb -r ./sidekiq.rb`
# * `ThisIsASidekiqJob.perform_async("hello", 10)`
require "sidekiq"
require 'datadog'
Datadog.configure { |c| c.tracing.instrument :sidekiq }
class ThisIsASidekiqJob
include Sidekiq::Job
def perform(some_arg = "potato", how_long = 1)
puts "Start of job!"
sleep how_long
puts "End of job!"
end
end
```
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 1.x-stable #3619 +/- ##
===========================================
Coverage 98.24% 98.25%
===========================================
Files 1255 1255
Lines 74569 74572 +3
Branches 3540 3540
===========================================
+ Hits 73262 73267 +5
+ Misses 1307 1305 -2 ☔ View full report in Codecov by Sentry. |
marcotc
approved these changes
May 1, 2024
AlexJF
approved these changes
May 2, 2024
This was referenced May 9, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR backports #3610 to the 1.x-stable branch. See original PR for more details.
Motivation:
We want to release this profiling feature in the 1.x-stable series as well.
Additional Notes:
I cherry-picked the upstream commits with no other changes.
How to test the change?
See original PR for details.