Use StringArrayVarP for --include and --exclude flags #196
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
Replace `StringSliceVarP` with `StringArrayVarP` for the --include and --exclude flags so regex strings can contain colons.
rkmathi
reviewed
Oct 16, 2022
There was a problem hiding this comment.
Thank you for your pull request!
I think this change is good.
To pass the test, could you please respond to the README as it needs to be changed?
./hack/verify-readme.sh
--- ./README.md 2022-10-16 01:37:3[5](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:6).[6](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:7)882[7](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:8)6651 +0000
+++ /tmp/tmp.decxYMhPJw 2022-10-16 01:3[8](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:9):36.[9](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:10)57049283 +0000
@@ -70,[11](https://github.com/stern/stern/actions/runs/3246025703/jobs/5349447581#step:6:12) +70,11 @@
`--container-state` | `running` | Tail containers with state in running, waiting or terminated. To specify multiple states, repeat this or set comma-separated value.
`--context` | | Kubernetes context to use. Default to current context configured in kubeconfig.
`--ephemeral-containers` | `true` | Include or exclude ephemeral containers.
- `--exclude`, `-e` | | Log lines to exclude. (regular expression)
+ `--exclude`, `-e` | `[]` | Log lines to exclude. (regular expression)
`--exclude-container`, `-E` | | Container name to exclude when multiple containers in pod. (regular expression)
`--exclude-pod` | | Pod name to exclude. (regular expression)
`--field-selector` | | Selector (field query) to filter on. If present, default to ".*" for the pod-query.
- `--include`, `-i` | | Log lines to include. (regular expression)
+ `--include`, `-i` | `[]` | Log lines to include. (regular expression)
`--init-containers` | `true` | Include or exclude init containers.
`--kubeconfig` | | Path to kubeconfig file to use. Default to KUBECONFIG variable then ~/.kube/config path.
`--namespace`, `-n` | | Kubernetes namespace to use. Default to namespace configured in kubernetes context. To specify multiple namespaces, repeat this or set comma-separated value.
|
@rkmathi I've updated README.md. PTAL. |
rkmathi
approved these changes
Dec 24, 2022
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.
Replace
StringSliceVarPwithStringArrayVarPfor the --include and --exclude flags so regex strings can contain colons.With the current
StringSliceVarPimplementation, it is impossible to accurately search for (or eliminate) a specific key/value pair if your service emits log lines in json:With these flags defined as
StringArrayVarPthis works correctly: