docs(operations): add profiling guide for PAC components#2602
docs(operations): add profiling guide for PAC components#2602theakshaypant merged 1 commit intotektoncd:mainfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces new documentation that guides users through the process of enabling and using Go runtime profiling (pprof) for Pipelines-as-Code components. The aim is to provide developers with the necessary information to diagnose and resolve performance bottlenecks, such as CPU hot-spots and memory leaks, by offering clear, step-by-step instructions for configuration, access, and secure operation of the profiling server. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation on how to enable and access profiling for Pipelines-as-Code components (watcher, webhook, and controller). The documentation details the use of Knative's profiling server, configuration via environment variables and ConfigMaps, and methods for capturing profiles. A suggestion was made to improve the clarity of the 'Accessing Profiles' section by providing concrete instructions using kubectl port-forward instead of generic host/port placeholders.
78df1e7 to
284778e
Compare
|
|
||
| ```bash | ||
| export POD_NAME=$(kubectl get pods -n pipelines-as-code \ | ||
| -l app.kubernetes.io/name=watcher \ |
There was a problem hiding this comment.
maybe make it that it mentions to choose watcher or controller
There was a problem hiding this comment.
Added the commands to get all of the pod names in 6f7e2e2
chmouel
left a comment
There was a problem hiding this comment.
smalll comment, feel free to auto approve after that
Document how to enable the Knative pprof profiling server on the watcher, webhook, and controller. Covers the ConfigMap toggle, PAC_DISABLE_HEALTH_PROBE requirement for the watcher, controller K_METRICS_CONFIG setup, exposing port 8008, and PROFILING_PORT override. Signed-off-by: Akshay Pant <akpant@redhat.com> Co-Authored-by: Claude <noreply@anthropic.com>
284778e to
6f7e2e2
Compare
📝 Description of the Change
Document how to enable the Knative pprof profiling server on the watcher, webhook, and controller. Covers the ConfigMap toggle, PAC_DISABLE_HEALTH_PROBE requirement for the watcher, controller K_METRICS_CONFIG setup, exposing port 8008, and PROFILING_PORT override.
🔗 Linked GitHub Issue
N/A
🧪 Testing Strategy
🤖 AI Assistance
AI assistance can be used for various tasks, such as code generation,
documentation, or testing.
Please indicate whether you have used AI assistance
for this PR and provide details if applicable.
Important
Slop will be simply rejected, if you are using AI assistance you need to make sure you
understand the code generated and that it meets the project's standards. you
need at least know how to run the code and deploy it (if needed). See
startpaac to make it easy
to deploy and test your code changes.
If the majority of the code in this PR was generated by an AI, please add a
Co-authored-bytrailer to your commit message.For example:
Co-authored-by: Claude noreply@anthropic.com
✅ Submitter Checklist
fix:,feat:) matches the "Type of Change" I selected above.make testandmake lintlocally to check for and fix anyissues. For an efficient workflow, I have considered installing
pre-commit and running
pre-commit installtoautomate these checks.