Skip to content

docs: add profiling section to README#767

Draft
mikenairn wants to merge 1 commit into
Kuadrant:mainfrom
mikenairn:add-pprof-readme-section
Draft

docs: add profiling section to README#767
mikenairn wants to merge 1 commit into
Kuadrant:mainfrom
mikenairn:add-pprof-readme-section

Conversation

@mikenairn
Copy link
Copy Markdown
Member

@mikenairn mikenairn commented May 14, 2026

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

  • Added ## Profiling section to README.md with kubectl port-forward and go tool pprof usage examples

Documents how to connect to the pprof endpoint
for runtime CPU and memory profiling.

Signed-off-by: Michael Nairn <mnairn@redhat.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 14, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6b1fcf91-e0df-487b-9500-34fa7071f085

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant