Skip to content

Commit d6269f9

Browse files
kppullinjmdeal
andauthored
docs: devlopment guide - add note about enabling the profiling flag (#7987)
Co-authored-by: Jason Deal <[email protected]>
1 parent d497c5b commit d6269f9

File tree

7 files changed

+28
-14
lines changed

7 files changed

+28
-14
lines changed

website/content/en/docs/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

website/content/en/preview/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

website/content/en/v0.32/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
157157
make setup
158158
```
159159

160-
## Profiling memory
161-
Karpenter exposes a pprof endpoint on its metrics port.
160+
## Profiling
161+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
162162

163163
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
164164

@@ -175,4 +175,6 @@ kubectl port-forward service/karpenter -n karpenter 8000
175175
open http://localhost:8000/debug/pprof/
176176
# Visualize the memory
177177
go tool pprof -http 0.0.0.0:9000 localhost:8000/debug/pprof/heap
178+
# Visualize CPU
179+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
178180
```

website/content/en/v1.0/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

website/content/en/v1.2/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

website/content/en/v1.3/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

website/content/en/v1.4/contributing/development-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Finally, to deploy the correct IAM permissions, including the instance profile f
158158
make setup
159159
```
160160

161-
## Profiling memory
162-
Karpenter exposes a pprof endpoint on its metrics port.
161+
## Profiling
162+
Karpenter exposes a pprof endpoint on its metrics port when [profiling]({{< relref "../reference/settings" >}}) is enabled.
163163

164164
Learn about profiling with pprof: https://jvns.ca/blog/2017/09/24/profiling-go-with-pprof/
165165

@@ -176,4 +176,6 @@ kubectl port-forward service/karpenter -n karpenter 8080
176176
open http://localhost:8080/debug/pprof/
177177
# Visualize the memory
178178
go tool pprof -http 0.0.0.0:9000 localhost:8080/debug/pprof/heap
179+
# Visualize CPU
180+
go tool pprof -http 0.0.0.0:9000 "localhost:8080/debug/pprof/profile?seconds=60"
179181
```

0 commit comments

Comments
 (0)