*: Make docs more accurate for the contention-profiling flag #114490
Merged
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
The --contention-profiling flag enables block profiling by calling SetBlockProfileRate(). It, however does not call SetMutexProfileFraction which enables mutex profiling. Mutex profiling gives us information about lock contention whereas block profiling on the other hand gives us information on gorotuines being blocked on sync primitives. Updating the docs to "block profiling" in order to make it more accurate. Eventhough a block profile may reflect contention points on locks to some extent, it also talks about other sources where goroutines may be blocked. Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
k8s-ci-robot
added
release-note
k8s-ci-robot
added
area/apiserver
area/kubelet
sig/api-machinery
|
/priority backlog |
k8s-ci-robot
added
priority/backlog
|
/priority important-longterm |
k8s-ci-robot
added
the
priority/important-longterm
|
/assign @MikeSpreitzer |
k8s-ci-robot
added
triage/accepted
|
/assign @ahg-g @derekwaynecarr @sttts |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: f418a60fc20469945dbff302dd5d093a4beeb68b
|
mrunalp
approved these changes
Jan 10, 2023
|
/approve a simple but important docs change |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dims, MadhavJivrajani, mrunalp The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
@dims is this something that is usually cherry-picked? |
This was referenced Jan 31, 2023
|
Created cherry-picks:
Since these docs are surfaced to the users. |
|
@MadhavJivrajani usually No! |
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.
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
The
--contention-profilingflag enables block profiling by calling SetBlockProfileRate(). It, however does not call SetMutexProfileFraction which enables mutex profiling.Mutex profiling gives us information about lock contention whereas block profiling on the other hand gives us information on gorotuines being blocked on sync primitives.
Updating the docs to "block profiling" in order to make it more accurate. Eventhough a block profile may reflect contention points on locks to some extent, it also talks about other sources where goroutines may be blocked.
Calling it lock contention may cause confusion, one such instance is kubernetes/perf-tests#2215
Which issue(s) this PR fixes:
Fixes # NA
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:
/sig docs