-
Notifications
You must be signed in to change notification settings - Fork 167
WIP - Add RedisSessionHealthChecker #7547
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| module Health | ||
| class RedisSessionController < AbstractHealthController | ||
| private | ||
|
|
||
| def health_checker | ||
| RedisSessionHealthChecker | ||
| end | ||
| end | ||
| end |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| module RedisSessionHealthChecker | ||
| module_function | ||
|
|
||
| # @return [HealthCheckSummary] | ||
| def check | ||
| HealthCheckSummary.new(healthy: health_write_and_read.present?, result: health_write_and_read) | ||
| rescue StandardError => err | ||
| NewRelic::Agent.notice_error(err) | ||
| HealthCheckSummary.new(healthy: false, result: err.message) | ||
| end | ||
|
|
||
| # @api private | ||
| def health_write_and_read | ||
| REDIS_POOL.with do |client| | ||
| client.setex(health_record_key, health_record_ttl, "healthy at " + Time.now.iso8601) | ||
| client.get(health_record_key) | ||
| end | ||
| end | ||
|
|
||
| # @api private | ||
| def health_record_key | ||
| "healthcheck_" + Socket.gethostname | ||
| end | ||
|
|
||
| # @api private | ||
| def health_record_ttl | ||
| # If we can't read back within a second that is just unacceptable | ||
| 1 | ||
| end | ||
| end | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| require 'rails_helper' | ||
|
|
||
| RSpec.describe RedisSessionHealthChecker do | ||
| describe '.check' do | ||
| subject(:summary) { RedisSessionHealthChecker.check } | ||
|
|
||
| context 'when the redis session store is healthy' do | ||
| it 'returns a healthy check' do | ||
| expect(summary.healthy).to eq(true) | ||
| expect(summary.result).to start_with("healthy at ") | ||
| end | ||
| end | ||
|
|
||
| context 'when the redis session store is unhealthy' do | ||
| before do | ||
| expect(RedisSessionHealthChecker).to receive(:simple_query). | ||
| and_raise(RuntimeError.new('canceling statement due to statement timeout')) | ||
| end | ||
|
|
||
| it 'returns an unhealthy check' do | ||
| expect(summary.healthy).to eq(false) | ||
| expect(summary.result).to include('canceling statement due to statement timeout') | ||
| end | ||
|
|
||
| it 'notifies NewRelic' do | ||
| expect(NewRelic::Agent).to receive(:notice_error) | ||
|
|
||
| summary | ||
| end | ||
| end | ||
| end | ||
| end |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a blocker, but would we want to check all the Redis pools?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could at least add a check for the rate limiting Redis. Attempts storage is not always enabled so seems like a conditional health check would be needed for that.
Should we combine it all here in one spot and call this
RedisHealthChecker?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that makes sense, yeah.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess they could be separate too, I don't have strong feelings, whatever is easier.