Support k8s objects variables in log format #1231
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
LorcanMcVeigh
requested review from
lucacome,
mikestephen,
pleshakov and
Dean-Coakley
pleshakov
previously requested changes
Nov 18, 2020
| @@ -205,7 +205,7 @@ See the doc about [VirtualServer and VirtualServerRoute resources](/nginx-ingres | |||
| * - ``log-format`` | |||
| - Sets the custom `log format <https://nginx.org/en/docs/http/ngx_http_log_module.html#log_format>`_ for HTTP and HTTPS traffic. For convenience, it is possible to define the log format across multiple lines (each line separated by ``\n``). In that case, the Ingress Controller will replace every ``\n`` character with a space character. All ``'`` characters must be escaped. | |||
There was a problem hiding this comment.
I think there is a misunderstanding that those variables should always be present in the log format. It is not the case - those variables should be available, but the admin may choose to not use them.
For the docs, it is necessary to describe what variables are available for admins to use and what they mean.
The example of the log line is useful. However, we should also have the example of a value you can put in the ConfigMap (the log format). So that the reader can copy that value and use it in their ConfigMap.
mikestephen
reviewed
Nov 25, 2020
mikestephen
reviewed
Nov 25, 2020
docs-web/configuration/global-configuration/configmap-resource.md
Outdated
Show resolved
Hide resolved
examples-of-custom-resources/basic-tcp-udp/global-configuration.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Mike Stephen <m.stephen@f5.com>
docs-web/configuration/global-configuration/configmap-resource.md
Outdated
Show resolved
Hide resolved
LorcanMcVeigh
force-pushed
the
update-log-format
branch
from
99791e2
to
9458ccf
Compare
Co-authored-by: Dean Coakley <dean.s.coakley@gmail.com>
Dean-Coakley
approved these changes
Nov 25, 2020
Co-authored-by: Dean Coakley <dean.s.coakley@gmail.com>
lucacome
approved these changes
Dec 1, 2020
pleshakov
changed the title
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.
Proposed changes
This PR updates the Ingress Controller log format for both Ingress and VirtualServer resources with k8s object details.
Checklist
Before creating a PR, run through this checklist and mark each as complete.