Add support or guidelines on installing the linux tools `perf` tool
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 1.4k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 5
Description
Is your feature request related to a problem? Please describe
First of all. We ❤️ GitPod at tremor. Tip of the hat to all involved!
One of the tools we use for performance analysis is the perf linux tool. It isn't obvious how to
install this as usual incantations via apt-get fail, and identifying the correct variant via uname -r
doesn't help.
Describe the behaviour you'd like
A minimal guide for how to get perf installed so perf stat, perf record can be run. Our
project happens to be primarily rust based, but we sometimes need to debug native libraries
such as librdkafka.
Describe alternatives you've considered
Alternatives include using dedicated hardware ( which we use for lengthy benchmark runs and
automated benchmarking via equinix metal ). However, having this within a gitpod workspace would
be useful to show new contributors to the project how to get started with benchmarking and used to
performance engineering tools.
Additional context
The following incantation may illustrate:
sudo apt-get install -y linux-tools linux-tools-`uname -r`
Reading package lists... Done
Building dependency tree
Reading state information... Done
Package linux-tools is a virtual package provided by:
linux-tools-virtual-hwe-20.04-edge 5.13.0.27.29~20.04.13
linux-tools-virtual-hwe-20.04 5.13.0.30.33~20.04.17
linux-tools-virtual 5.4.0.100.104
linux-tools-oracle-lts-20.04 5.4.0.1064.64
linux-tools-oracle-edge 5.13.0.1018.22~20.04.1
linux-tools-oracle 5.13.0.1018.22~20.04.1
linux-tools-oem-20.04d 5.14.0.1024.22
linux-tools-oem-20.04 5.14.0.1024.22
linux-tools-lowlatency-hwe-20.04-edge 5.13.0.27.29~20.04.13
linux-tools-lowlatency-hwe-20.04 5.13.0.30.33~20.04.17
linux-tools-lowlatency 5.4.0.100.104
linux-tools-intel 5.13.0.1009.10
linux-tools-ibm-lts-20.04 5.4.0.1015.16
linux-tools-ibm 5.4.0.1015.16
linux-tools-gkeop-5.4 5.4.0.1034.37
linux-tools-gkeop 5.4.0.1034.37
linux-tools-gke-edge 5.13.0.1013.16~20.04.1
linux-tools-gke-5.4 5.4.0.1063.73
linux-tools-gke 5.4.0.1063.73
linux-tools-generic-hwe-20.04-edge 5.13.0.27.29~20.04.13
linux-tools-generic-hwe-20.04 5.13.0.30.33~20.04.17
linux-tools-generic 5.4.0.100.104
linux-tools-gcp-lts-20.04 5.4.0.1065.75
linux-tools-gcp-edge 5.13.0.1015.18~20.04.2
linux-tools-gcp 5.13.0.1015.18~20.04.2
linux-tools-aws-lts-20.04 5.4.0.1066.68
linux-tools-aws-edge 5.13.0.1014.15~20.04.7
linux-tools-aws 5.13.0.1014.15~20.04.7
You should explicitly select one to install.
E: Package 'linux-tools' has no installation candidate
E: Unable to locate package linux-tools-5.16.14-051614-generic
E: Couldn't find any package by glob 'linux-tools-5.16.14-051614-generic'
E: Couldn't find any package by regex 'linux-tools-5.16.14-051614-generic'
And, the result of uname -r
uname -r
5.16.14-051614-generic
The perf tool needs to target the correct kernel version so this was a good place to stop where
auto discovering same wasn't successful.
Also - learning heaps from your Docker repo too 👍
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No repository file or test is named. Start by locating Gitpod's workspace documentation or image configuration for Ubuntu package installation, then verify the documented approach installs perf and allows perf stat and perf record to run. Done means a minimal, reproducible guide addresses the kernel-version mismatch shown in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- linux, ubuntu
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100