docs: add profiling section to README#767
Draft
mikenairn wants to merge 1 commit into
Draft
Conversation
Documents how to connect to the pprof endpoint for runtime CPU and memory profiling. Signed-off-by: Michael Nairn <mnairn@redhat.com>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
4 tasks
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
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.
Summary
Adds a Profiling section to the README documenting how to connect to the existing pprof endpoint for runtime CPU and memory profiling.
The dns-operator already has pprof enabled by default on
:8082— this PR just adds the documentation.Motivation
pprof is the standard mechanism for diagnosing performance issues in Go applications. The Kubernetes kube-apiserver enables profiling via
--profiling(default:true), exposing the same/debug/pprof/endpoints. While dns-operator already has the pprof endpoint, there was no documentation on how to use it.Changes
## Profilingsection to README.md withkubectl port-forwardandgo tool pprofusage examples