Enhance NIC table field descriptions for better clarity on IRQBalance… #522
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
… and coalescing settings Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation of the NIC table in the report by adding descriptive text to five technical fields related to interrupt handling and coalescing. These descriptions help users understand how each setting affects system performance and network latency.
Key changes:
- Added description for IRQBalance explaining its role in distributing interrupts across cores
- Added descriptions for Adaptive RX/TX explaining dynamic coalescing adjustments
- Added descriptions for rx-usecs and tx-usecs explaining the latency vs. CPU usage tradeoff
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.
This pull request enhances the clarity and usability of the NIC table in the report by adding detailed descriptions to several technical fields. These descriptions help users better understand the purpose and impact of each setting, particularly for interrupt handling and coalescing parameters.
Improvements to NIC table field documentation:
Descriptionfields toIRQBalance,Adaptive RX,Adaptive TX,rx-usecs, andtx-usecsin thenicTableValuesfunction withininternal/report/table_defs.go, explaining their roles and effects on system performance and network latency.… and coalescing settings