Add Rails cache store instrumentation filter #4693
Open
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4693 +/- ##
=======================================
Coverage 97.64% 97.64%
=======================================
Files 1470 1470
Lines 87707 87742 +35
Branches 4547 4551 +4
=======================================
+ Hits 85644 85680 +36
+ Misses 2063 2062 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
drichards-87
approved these changes
May 28, 2025
| @@ -552,6 +552,7 @@ cache.read('city') | |||
| | --------------- | - | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | | |||
| | `enabled` | `DD_TRACE_ACTIVE_SUPPORT_ENABLED` | `Bool` | Whether the integration should create spans. | `true` | | |||
| | `cache_service` | | `String` | Name of application running the `active_support` instrumentation. May be overridden by `global_default_service_name`. [See _Additional Configuration_ for more details](#additional-configuration) | `active_support-cache` | | |||
| | `cache_store` | | `Array` | Specifies which cache stores to instrument. Accepts a list of store names (e.g. `memory_store`, `file_store`, or symbols like `:file_store`). If set, only the listed stores will be traced. By default (`nil`), it traces all stores. | `nil` | | |||
There was a problem hiding this comment.
Suggested change
| | `cache_store` | | `Array` | Specifies which cache stores to instrument. Accepts a list of store names (e.g. `memory_store`, `file_store`, or symbols like `:file_store`). If set, only the listed stores will be traced. By default (`nil`), it traces all stores. | `nil` | | |
| | `cache_store` | | `Array` | Specifies which cache stores to instrument. Accepts an array of store names such as `memory_store`, `file_store`, or symbols like `:file_store`. If set, only the listed stores are traced. Defaults to `nil`, which traces all stores. | `nil` | |
There was a problem hiding this comment.
Should the option be in plural, i.e. cache_stores?
BenchmarksBenchmark execution time: 2025-05-28 19:56:58 Comparing candidate commit c1ef3f8 in PR branch Found 1 performance improvements and 2 performance regressions! Performance is the same for 37 metrics, 5 unstable metrics. scenario:profiling - Allocations ()
scenario:tracing - Propagation - Trace Context
scenario:tracing - Tracing.log_correlation
|
p-datadog
reviewed
May 29, 2025
| @@ -552,6 +552,7 @@ cache.read('city') | |||
| | --------------- | - | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | | |||
| | `enabled` | `DD_TRACE_ACTIVE_SUPPORT_ENABLED` | `Bool` | Whether the integration should create spans. | `true` | | |||
| | `cache_service` | | `String` | Name of application running the `active_support` instrumentation. May be overridden by `global_default_service_name`. [See _Additional Configuration_ for more details](#additional-configuration) | `active_support-cache` | | |||
| | `cache_store` | | `Array` | Specifies which cache stores to instrument. Accepts a list of store names (e.g. `memory_store`, `file_store`, or symbols like `:file_store`). If set, only the listed stores will be traced. By default (`nil`), it traces all stores. | `nil` | | |||
There was a problem hiding this comment.
Should the option be in plural, i.e. cache_stores?
| o.type :array, nilable: true | ||
| o.default nil | ||
| o.after_set do |stores| | ||
| stores&.map!(&:to_s) # Convert symbols to strings to match the Rails configuration format |
There was a problem hiding this comment.
Is the customer-supplied array duped during assignment? Otherwise this would mutate their data.
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 introduces a new
:cache_storeconfiguration option to the ActiveSupport integration. This option allows users to specify which cache stores should be instrumented by Datadog tracing.Motivation:
This is important for very fast backends, like MemoryStore, which might not provide useful spans.
Change log entry
Yes. Add
:cache_storeoption to ActiveSupport integration to allow tracing only specified cache backends.Additional Notes:
['file_store', :memory_store]).How to test the change?
:cache_storeincludes, excludes, or is unset for various backends.Datadog.configure { |c| c.tracing.instrument :active_support, cache_store: [:file_store] }and verify that only the specified store is traced.