Skip to content

Commit 002ec4b

Browse files
authored
Merge pull request #6017 from adisky/patch-4
Update node perf testing doc
2 parents 3868a85 + e45fe72 commit 002ec4b

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

contributors/devel/sig-node/node-performance-testing.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ must be taken in setting up the cluster to make the intended measurements. In
1010
addition to taking the following steps into consideration, it is important to
1111
document precisely which setup was used. For example, performance can vary
1212
wildly from commit-to-commit, so it is very important to **document which commit
13-
or version** of Kubernetes was used, which Docker version was used, etc.
13+
or version** of Kubernetes was used, which container runtime version was used, etc.
1414

1515
### Addon pods
1616

@@ -54,18 +54,33 @@ environment etc. with a single node to worry about. On the other hand, having
5454
multiple nodes will let you gather more data in parallel for more robust
5555
sampling.
5656

57-
## E2E Performance Test
57+
## Performance Dashboard
58+
Since Kubernetes release 1.22 kubelet resource usage is also being tracked via [k8s performance dashboard](http://perf-dash.k8s.io/).
5859

60+
## E2E Performance Test
5961
There is an end-to-end test for collecting overall resource usage of node
6062
components: [kubelet_perf.go](https://git.k8s.io/kubernetes/test/e2e/node/kubelet_perf.go). To
6163
run the test, simply make sure you have an e2e cluster running (`kubetest --up`) and [set up](#cluster-set-up) correctly.
6264

6365
Run the test with `kubetest --test --test_args="--ginkgo.focus=resource\susage\stracking"`. You may also wish to customise the number of pods or other parameters of the test (remember to rerun
6466
`make WHAT=test/e2e/e2e.test` after you do).
6567

68+
Note: Due to the amount of time those tests consume they are not currently running in CI, see [issue](https://github.com/kubernetes/kubernetes/issues/81490).
69+
70+
## Node E2E Peformance Test
71+
These node e2e tests measure node performance after deploying performance sensitive workloads.
72+
73+
source: https://github.com/kubernetes/kubernetes/blob/master/test/e2e_node/node_perf_test.go
74+
75+
testgrid : https://testgrid.k8s.io/sig-node-kubelet#node-performance-test
76+
77+
To run theses tests follow [node e2e setup guide](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md) and run
78+
```make test-e2e-node FOCUS="Node Performance Testing" SKIP="" PARALLELISM=1```
79+
6680
## Profiling
6781

68-
Kubelet installs the [go pprof handlers](https://golang.org/pkg/net/http/pprof/), which can be queried for CPU profiles:
82+
Kubelet installs the [go pprof handlers](https://golang.org/pkg/net/http/pprof/), which can be queried for CPU profiles.
83+
To enable the pprof endpint for kubelet pass `--enable-debugging-handlers=true` as kubelet flag or `EnableDebuggingHandlers=true` as a kubelet configuration option.
6984

7085
```console
7186
$ kubectl proxy &

0 commit comments

Comments
 (0)