-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Documentation: Explain --config.expand-env=true double slash with slash substitution #6139
Conversation
./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell. + ingester 0%
+ distributor 0%
+ querier 0%
+ querier/queryrange 0%
+ iter 0%
+ storage 0%
+ chunkenc 0%
+ logql 0%
+ loki 0% |
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.
thanks @V-Mann-Nick 👍 LGTM. Added one small suggestion with linking reference.
Co-authored-by: Kaviraj Kanagaraj <kavirajkanagaraj@gmail.com>
Thanks for the suggestions @kavirajk. Didn't know that. I committed them. |
./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell. + ingester 0%
+ distributor 0%
+ querier 0%
+ querier/queryrange 0%
+ iter 0%
+ storage 0%
+ chunkenc 0%
+ logql 0%
+ loki 0% |
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.
Thanks @V-Mann-Nick LGTM
What this PR does / why we need it:
When I was configuring Promtail to use a regex stage I escaped slashes in regular expressions when using double quotes in yaml files. But no where did it explain that when using the option
--config.expand-env=true
the programenvsubst
would replace double slashes with slashes. I found the issue #3635 to find out this is behavior as expected. While I accept this, I thought it would be useful to warn the next person about just this case.Adds two paragraphs to the Promtail configuration docs:
docs/sources/clients/promtail/configuration.md
: use double slashes for single slashes when usingexpand-env=true
docs/sources/clients/promtail/stages/regex.md
: explained again as it's more likely to use back slashes in regexWhich issue(s) this PR fixes:
Although already closed it's related to the following: Fixes #3635
Checklist
CHANGELOG.md
.docs/sources/upgrading/_index.md