Skip to content

Commit

Permalink
docs: Fix typos, and PprofBindAddress related description.
Browse files Browse the repository at this point in the history
  • Loading branch information
TAM360 committed Sep 13, 2024
1 parent 4906e95 commit 6338a0a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/book/src/cronjob-tutorial/pprof-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Using Pprof for Controller Profiling

Pprof is a Go based library designed for profiling the binary in order to gather CPU, and Memory related data. Pprof is help in finding any sort of bottle necks that are either appearing at Memory, CPU, or both levels.
Pprof is a Go based library designed for profiling the binary in order to gather CPU, and Memory related data. Pprof is helpful in finding any sort of bottlenecks that are appearing either at Memory, CPU, or both levels.

Pprof itself runs as a tiny HTTP server as part of the the Controller. You can extract the statistics, and visualize them on an interactive website. Furthermore, **you don't need to install this package seperately**. Pprof comes packaged as part of Kubebuilder `controller-runtime` [dependency](https://github.com/kubernetes-sigs/controller-runtime/pull/1943) within the scafolded project.
Pprof itself runs as part of the the Controller. You can extract the statistics, and visualize them on an interactive website. Furthermore, **you don't need to install this package seperately**. Pprof comes packaged as part of Kubebuilder `controller-runtime` [dependency](https://github.com/kubernetes-sigs/controller-runtime/pull/1943) within the scafolded project.

For further information about the Pprof usage, check out the official [docs](https://github.com/google/pprof).

Expand All @@ -15,7 +15,9 @@ For further information about the Pprof usage, check out the official [docs](htt
....
Scheme: scheme,
LeaderElection: enableLeaderElection,
PprofBindAddress: "127.0.0.1:8082", // Specify your own URL here.
// PprofBindAddress is the TCP address that the controller should bind to
// for serving pprof. Specify the manager address and the port that should be bind.
PprofBindAddress: "127.0.0.1:8082",
...
})
```
Expand Down

0 comments on commit 6338a0a

Please sign in to comment.