Silence healthcheck requests from the log #52789
Merged
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
skipkayhil
reviewed
Sep 3, 2024
Thanks to @skipkayhil for reminding me of Propshaft::QuietAssets which does something very similar and does it just via env!
skipkayhil
reviewed
Sep 3, 2024
Co-authored-by: Hartley McGuire <skipkayhil@gmail.com>
ghiculescu
reviewed
Sep 6, 2024
| assert_includes middleware, "ActionDispatch::AssumeSSL" | ||
| end | ||
|
|
||
| test "ActionDispatch::SSL is present when force_ssl is set" do |
There was a problem hiding this comment.
@dhh did you mean to delete this test?
There was a problem hiding this comment.
I did not. Not sure what happened there. Please do PR to restore!
|
Will this ship in Rails 8, or in an earlier point release? |
|
|
@dhh how do you feel abstracting this to a |
|
@cristianbica Are any of those examples you mention problems you've actually hit in production? At what intervals are those requests running? I don't want to blanket rule out making this more generic, but I find that you're better off with something specific, unless you've proven without a doubt the need for something generic. |
|
@dhh In our app we have an async request for red dot / badge counts that happens on most page loads. I recently wrote a very similar middleware to filter those out of the development logs as I got bored of scrolling back up the tail past the badge request to see details of the main request. Having something configurable like @cristianbica is suggesting, and being able to be different in different environments would certainly have been great for our real use case. |
@dhh on my current projects I do not have a valid use-case to prove the need to generalize this functionality. In the past projects I've implemented different solution to reduce logging (e.g. silencer gem for requests). The purpose was to reduce clutter in the logs and reduce costs. From what I remember:
Anyway, looking at the implementation in this PR, one could easy filter out logging for other paths by adding to config.middleware.insert_before ::Rails::Rack::Logger, :Rails::Rack::SilenceRequest, path: '/sidekiq_stats' |
DanielaVelasquez
pushed a commit
to DanielaVelasquez/rails
that referenced
this pull request
Oct 3, 2024
* Add SilenceRequest middleware * Make config.silence_healthcheck a way to quiet "/up"
|
@dhh With thruster gem included by default, the "/up" requests are showing up in the logs anyway. Is there any way to silence that as well, as I don't see such possibility in thruster project yet? |
lfdebrux
added a commit
to alphagov/forms-admin
that referenced
this pull request
Sep 23, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-runner
that referenced
this pull request
Sep 23, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-product-page
that referenced
this pull request
Sep 23, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-api
that referenced
this pull request
Sep 23, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-admin
that referenced
this pull request
Sep 24, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-runner
that referenced
this pull request
Sep 26, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-product-page
that referenced
this pull request
Sep 26, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-product-page
that referenced
this pull request
Sep 26, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
lfdebrux
added a commit
to alphagov/forms-api
that referenced
this pull request
Sep 26, 2025
Since Rails 8, the health check controller logs are filtered out from the log stream by default [[1]]. All our apps are now using Rails 8 and have `config.silence_healthcheck_path` enabled [[2]], so we stopped filtering out log lines containing `/up` in our log forwarding configuration [[3]]. However, this doesn't appear to have worked, as we are now seeing logs from the healthcheck controller. This is probably because of how Lograge works; this commit adds an additional configuration line to tell Lograge to ignore logs for the healthcheck controller, matching the Rails default. [1]: rails/rails#52789 [2]: https://guides.rubyonrails.org/configuring.html#config-silence-healthcheck-path [3]: alphagov/forms-deploy#1720
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 default Rails health check is intended to be hit every second or so by Kamal to ensure that the application is still or has just become responsive. This clutters up the production logs and makes it hard to follow what's actually going on. This adds a new middleware called
Rails::Rack::SilenceRequestthat is used by a new configconfig.silence_healthcheck = pathto prevent that.