feat: Unconditionally produce debug comments #2141
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
buchdag
reviewed
Jan 18, 2023
|
@rhansen I completely agree on removing the per proxied container |
No, I don't think it's necessary. The extra comments are harmless. |
Rationale for eliminating the check to see if the `DEBUG` environment
variable holds a true value:
* The `DEBUG` environment variable might be set on a container (for
purposes specific to that container, not `nginx-proxy`) to a value
that cannot be parsed as a bool, which would break `nginx-proxy`.
* It simplifies the template.
* It eliminates a cold code path.
* It avoids heisenbugs.
* It makes debugging easier for users.
Also delete the debug info tests, as they are fragile and they provide
limited value.
Alternatively, we could avoid collision with the container's use of
the `DEBUG` environment variable by using a container label [1] such
as `com.google.nginx-proxy.nginx-proxy.debug`. I think doing so has
dubious value, especially if we want to attempt backwards
compatibility with the `DEBUG` environment variable.
Fixes nginx-proxy#2139
[1] https://docs.docker.com/engine/reference/commandline/run/#-set-metadata-on-container--l---label---label-file
Co-authored-by: Nicolas Duchon <nicolas.duchon@gmail.com>
|
@GGORG0 Does this PR solve your problem? |
buchdag
approved these changes
Jan 20, 2023
I had more in mind users that would like a "clean" config generated, in the same way as you don't always want debug informations on your application logs. I leave that up to you, this can be merged as is so that @GGORG0 can test it more easily. |
This was referenced Jan 23, 2023
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.
Rationale for eliminating the check to see if the
DEBUGenvironment variable holds a true value:DEBUGenvironment variable might be set on a container (for purposes specific to that container, notnginx-proxy) to a value that cannot be parsed as a bool, which would breaknginx-proxy.Also delete the debug info tests, as they are fragile (e.g., they break if IPv6 is enabled) and they provide limited value.
Alternatively, we could avoid collision with the container's use of the
DEBUGenvironment variable by using a container label such ascom.google.nginx-proxy.nginx-proxy.debug. I think doing so has dubious value, especially if we want to attempt backwards compatibility with theDEBUGenvironment variable.Fixes #2139
cc @GGORG0