actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-08 16:57:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
fluxcd-flux2/docs/dev-guides/debugging.md
Hidde Beydals 0b10ed4d88 Add guide for pprof endpoints 
Signed-off-by: Hidde Beydals <hello@hidde.co>
2021-02-12 13:44:35 +01:00

1.2 KiB
Raw Blame History

Advanced debugging

This guide covers more advanced debugging topics such as collecting runtime profiling data from GitOps Toolkit components.

As a user, this page normally should be a last resort, but you may be asked by a maintainer to share a collected profile to debug e.g. performance issues.

Pprof

The GitOps Toolkit components serve pprof runtime profiling data on their metrics HTTP server (default :8080).

Endpoints

Endpoint Path
Index /debug/pprof/
CPU profile /debug/pprof/profile
Symbol /debug/pprof/symbol
Trace /debug/pprof/trace

Collecting a profile

To collect a profile, port-forward to the component's metrics endpoint and collect the data from the endpoint of choice:

$ kubectl port-forward -n <namespace> deploy/<component> 8080
$ curl -Sk -v http://localhost:8080/debug/pprof/heap > heap.out

The collected profile can be analyzed using go, or shared with one of the maintainers.