Improve http_service.checks documentation #1862
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
For the `method` and `protocol` options, indicate that the default values (if omitted) are `get` and `http`, respectively. Additionally, add a warning section that warns about common issues with redirects (or any non-200 response). One such example is that, by default, a standard Rails application includes `config.force_ssl = true` in `config/environments/production.rb`, which causes a health check request to http://0.0.0.0:3000/up to receive a 301 redirect to https://0.0.0.0:3000/up (and the default puma config for Rails is not configured to accept SSL requests). The warning includes some guidance about adding an `X-Forwarded-Proto = "https"` header to the health check to avoid this sort of redirect.
Linter complains about http and https, so hoping that wrapping these in backticks is enough to silence these warnings.
|
Just bumping this low priority PR as it may have slipped off everybody’s radar. There was initially some linter errors on the first build attempt, but I believe they have been addressed so this seems to just be awaiting an approval to rerun the workflow. Thanks. |
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.
Summary of changes
For the
methodandprotocoloptions, indicate that the default values (if omitted) aregetandhttp, respectively.Additionally, add a warning section that warns about common issues with redirects (or any non-200 response).
One such example is that, by default, a standard Rails application includes
config.force_ssl = trueinconfig/environments/production.rb, which causes a health check request to http://0.0.0.0:3000/up to receive a 301 redirect to https://0.0.0.0:3000/up (and the default puma config for Rails is not configured to accept SSL requests).The warning includes some guidance about adding an
X-Forwarded-Proto = "https"header to the health check to avoid this sort of redirect.Related Fly.io community and GitHub links
https://community.fly.io/t/http-service-checks-random-questions/22424