Add support for redis-clustering gem #2720
Merged
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
kaylareopelle
changed the title
kaylareopelle
commented
Jul 2, 2024
| @@ -33,6 +34,10 @@ | |||
| NewRelic::Agent.logger.info('Installing Redis Instrumentation') | |||
| if NewRelic::Agent::Instrumentation::Redis::Constants::HAS_REDIS_CLIENT | |||
| RedisClient.register(NewRelic::Agent::Instrumentation::RedisClient::Middleware) | |||
|
|
|||
| if defined?(Redis::Cluster::Client) | |||
| return RedisClient.register(NewRelic::Agent::Instrumentation::RedisClient::ClusterMiddleware) | |||
There was a problem hiding this comment.
redis-clustering doesn't need prepend nor chain instrumentation, those methods are instrumented in the ClusterMiddleware.
Comment on lines
+10
to
+16
| # Until we decide to move our Redis instrumentation entirely off patches | ||
| # keep the middleware instrumentation for the call and connect methods | ||
| # limited to the redis-clustering instrumentation. | ||
| # | ||
| # Redis's middleware option does not capture errors as high in the stack | ||
| # as our patches. Leaving the patches for call and connect on the main | ||
| # Redis gem limits the feature disparity our customers experience. |
There was a problem hiding this comment.
I see this as a way to have a clean break for new Redis instrumentation. However, it does provide an inferior experience for error handling. We can look more closely into monkey-patching these methods, but we'll need to patch methods differently than we do for the main Redis gem.
| @@ -59,6 +59,8 @@ def test_records_metrics_for_connect | |||
| end | |||
|
|
|||
| def test_records_connect_tt_node_within_call_that_triggered_it | |||
| skip_for_redis_clustering_gem | |||
There was a problem hiding this comment.
In the end, it seemed the least intrusive to add skips for the six tests that are not compatible with redis-clustering instrumentation:
- We can't test with
Redis::Cluster.newbecause we don't have a cluster mode enabled service running for our tests, so we're faking the "cluster" testing regardless - We don't have a different configuration option for
redis-clusteringthan we do forredis, so the prepend/chain configurations seemed excessive - Skipping the tests feels easier to read and understand the feature disparity between the two gems quickly
Open to further discussion to take a different approach!
kaylareopelle
requested review from
fallwith,
hannahramadan and
tannalynn
as code owners
fallwith
approved these changes
Jul 2, 2024
tannalynn
reviewed
Jul 2, 2024
Co-authored-by: James Bunch <[email protected]>
…agent into redis-clustering
* Log the failure message at the debug level * Check for the presence of the #db method on the client config object using respond_to?
SimpleCov Report
|
tannalynn
approved these changes
Jul 3, 2024
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.
The
redis-clusteringgem provides the ability to use Redis in cluster mode for Ruby. Cluster mode is enabled by default for AWS Elasticache Redis clusters.The
redis-clusteringmove was part of the large refactor of the Redis gem in the 5.0 release. It can leverage RedisClient middleware to instrument code.This PR provides the following:
dbmethod that is compatible with the Redis gem for all our supported versions, renamed tonr_dbNewRelic::Agent::Instrumentation::RedisClient::ClusterMiddleware, that provides instrumentation for thecallandconnectmethods.callandconnectmethods because they are invoked too late to capture certain errors. Keeping module prepending for these methods keeps feature parity for users of newer Redis versionsResolves #2444