Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: improve help message with regards to how filters are applied #433

Closed
rolinh opened this issue Nov 20, 2020 · 0 comments · Fixed by #1203
Closed

doc: improve help message with regards to how filters are applied #433

rolinh opened this issue Nov 20, 2020 · 0 comments · Fixed by #1203
Labels
📄 area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. 👍 good-first-issue Good starting point for new developers, which requires minimal understanding of Hubble. 🙏 help-wanted Please volunteer for this by adding yourself as an assignee!

Comments

@rolinh
Copy link
Member

rolinh commented Nov 20, 2020

hubble help observe currently provides the following help message:

Observe provides visibility into flow information on the network and
application level. Rich filtering enable observing specific flows related to
individual pods, services, TCP connections, DNS queries, HTTP requests and
more.

Usage:
  hubble observe [flags]
(...)

Something crucial that is missing from the help message is an explanation about how various filters are combined together.

@michi-covalent provided a good explanation in this PR comment. It could be adapted/extended to explain how this applies to hubble observe also with extended information about how the --not filter works in combination of the others.
@rolinh rolinh added the 📄 area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Nov 20, 2020
@kaworu kaworu added the 👍 good-first-issue Good starting point for new developers, which requires minimal understanding of Hubble. label Nov 23, 2020
@rolinh rolinh added the 🙏 help-wanted Please volunteer for this by adding yourself as an assignee! label Nov 23, 2020
glrf added a commit to glrf/hubble that referenced this issue Sep 6, 2023
@glrf
Add filter flag documentation and examples to help message
636bef3 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: cilium#433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
glrf added a commit to glrf/hubble that referenced this issue Sep 7, 2023
@glrf
Add filter flag documentation and examples to help message
be127f5 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: cilium#433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
glrf added a commit to glrf/hubble that referenced this issue Sep 7, 2023
@glrf
Add filter flag documentation and examples to help message
980c03c 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: cilium#433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
glrf added a commit to glrf/hubble that referenced this issue Sep 8, 2023
@glrf
Add filter flag documentation and examples to help message
210c9fb 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: cilium#433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
@kaworu kaworu linked a pull request Sep 11, 2023 that will close this issue
Add filter flag documentation and examples to help message #1203
Merged
glrf added a commit to glrf/hubble that referenced this issue Sep 12, 2023
@glrf
Add filter flag documentation and examples to help message
d95a5f4 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: cilium#433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
kaworu pushed a commit that referenced this issue Sep 26, 2023
@glrf @kaworu
Add filter flag documentation and examples to help message
d62ec63 
The Hubble CLI provides multiple different flags to filter the returned
flows. However how these filters are combined is not entirely obvious.

This commit adds more detailed help message and multiple examples that
explain how these filters interact if more than one filter flag is
provided.

Fixes: #433

Signed-off-by: Fabian Fischer <fabian.fischer@isovalent.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📄 area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. 👍 good-first-issue Good starting point for new developers, which requires minimal understanding of Hubble. 🙏 help-wanted Please volunteer for this by adding yourself as an assignee!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add filter flag documentation and examples to help message glrf/hubble
2 participants
@kaworu @rolinh