pkg/gadgets/top/tcp: Align IP version field with other gadgets #2564
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
This change is particularly useful for those folks consuming the JSON
output from other applications:
Before this commit ("ipversion":2):
$ ig top tcp -o json
[{"runtime":{...},"k8s":{},"mountnsid":4026534246,"pid":19366,"comm":"kubelet","ipversion":2,"src":{"addr":"192.168.49.2","version":4,"port":39304},"dst":{"addr":"192.168.49.2","version":4,"port":8443},"sent":566,"received":2056}]
After this commit ("ipversion":4):
$ ig top tcp -o json
[{"runtime":{...},"k8s":{},"mountnsid":4026534246,"pid":19366,"comm":"kubelet","ipversion":4,"src":{"addr":"192.168.49.2","version":4,"port":35098},"dst":{"addr":"192.168.49.2","version":4,"port":8443},"sent":566,"received":2056}]
Signed-off-by: Jose Blanquicet <josebl@microsoft.com>
blanquicet
force-pushed
the
jose/top-tcp-ipversion
branch
from
ca422b9
to
185a507
Compare
flyth
approved these changes
Mar 4, 2024
| @@ -49,7 +49,7 @@ type Stats struct { | |||
|
|
|||
| Pid int32 `json:"pid,omitempty" column:"pid,template:pid"` | |||
| Comm string `json:"comm,omitempty" column:"comm,template:comm"` | |||
| IPVersion uint16 `json:"ipversion,omitempty" column:"ip,template:ipversion"` | |||
| IPVersion int `json:"ipversion,omitempty" column:"ip,template:ipversion"` | |||
There was a problem hiding this comment.
Although we don't transmit this in binary form, yet, IMHO we should always use types with a fixed size (that aren't platform dependent) for things that can be exchanged between two different systems.
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.
Align IP version field of top tcp with other gadgets
The top tcp gadget reports the IPVersion field as the address family
AF_INETorAF_INET6. Instead, all other gadgets reporting such a field use4or6directly, which avoids further manipulation of output on CLI or third-party applications consuming the JSON. Gadgets using4and6:This change is beneficial for those folks consuming the JSON output from other applications:
Before this commit ("ipversion":2)
$ ig top tcp -o json [{"runtime":{...},"k8s":{},"mountnsid":4026534246,"pid":19366,"comm":"kubelet","ipversion":2,"src":{"addr":"192.168.49.2","version":4,"port":39304},"dst":{"addr":"192.168.49.2","version":4,"port":8443},"sent":566,"received":2056}]After this commit ("ipversion":4)
$ ig top tcp -o json [{"runtime":{...},"k8s":{},"mountnsid":4026534246,"pid":19366,"comm":"kubelet","ipversion":4,"src":{"addr":"192.168.49.2","version":4,"port":35098},"dst":{"addr":"192.168.49.2","version":4,"port":8443},"sent":566,"received":2056}]NOTE
Isn't the version inside the src and dst redundant? I think we could avoid it.