Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yahoo/kubectl-flame
Kubectl plugin for effortless profiling on kubernetes
https://github.com/yahoo/kubectl-flame
docker golang hacktoberfest java kubernetes performance
Last synced: 3 days ago
JSON representation
Kubectl plugin for effortless profiling on kubernetes
- Host: GitHub
- URL: https://github.com/yahoo/kubectl-flame
- Owner: yahoo
- License: apache-2.0
- Created: 2020-08-13T16:36:06.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T20:15:05.000Z (10 months ago)
- Last Synced: 2024-08-01T13:24:10.851Z (3 months ago)
- Topics: docker, golang, hacktoberfest, java, kubernetes, performance
- Language: Go
- Homepage:
- Size: 85.9 KB
- Stars: 783
- Watchers: 11
- Forks: 93
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- License: LICENSE
- Code of conduct: Code-of-Conduct.md
Awesome Lists containing this project
- awesome-repositories - yahoo/kubectl-flame - Kubectl plugin for effortless profiling on kubernetes (Go)
- awesome-starred - yahoo/kubectl-flame - Kubectl plugin for effortless profiling on kubernetes (kubernetes)
README
# kubectl flame :fire:
A kubectl plugin that allows you to profile production applications with low-overhead by generating
[FlameGraphs](http://www.brendangregg.com/flamegraphs.html)
Running `kubectlf-flame` does **not** require any modification to existing pods.
## Table of Contents
- [Requirements](#requirements)
- [Usage](#usage)
- [Installing](#installing)
- [How it works](#how-it-works)
- [Contribute](#contribute)
- [Maintainers](#maintainers)
- [License](#license)
## Requirements
* Supported languages: Go, Java (any JVM based language), Python, Ruby, and NodeJS
* Kubernetes cluster that use Docker as the container runtime (tested on GKE, EKS and AKS)
## Usage
### Profiling Kubernetes Pod
In order to profile a Java application in pod `mypod` for 1 minute and save the flamegraph as `/tmp/flamegraph.svg` run:
```shell
kubectl flame mypod -t 1m --lang java -f /tmp/flamegraph.svg
```
### Profiling Alpine based container
Profiling Java application in alpine based containers require using `--alpine` flag:
```shell
kubectl flame mypod -t 1m -f /tmp/flamegraph.svg --lang java --alpine
```
*NOTICE*: this is only required for Java apps, the `--alpine` flag is unnecessary for Go profiling.
### Profiling sidecar container
Pods that contains more than one container require specifying the target container as an argument:
```shell
kubectl flame mypod -t 1m --lang go -f /tmp/flamegraph.svg mycontainer
```
### Profiling Golang multi-process container
Profiling Go application in pods that contains more than one process require specifying the target process name via `--pgrep` flag:
```shell
kubectl flame mypod -t 1m --lang go -f /tmp/flamegraph.svg --pgrep go-app
```
Java profiling assumes that the process name is `java`. Use `--pgrep` flag if your process name is different.
### Profiling on clusters running containerd
To run this tool on Kubernetes clusters that use containerd as the runtime engine, you must specify the path to the containerd runtime files:
```shell
kubectl flame mypod -t 1m --docker-path /run/containerd
```
## Installing
### Krew
You can install `kubectl flame` using the [Krew](https://github.com/kubernetes-sigs/krew), the package manager for kubectl plugins.
Once you have [Krew installed](https://krew.sigs.k8s.io/docs/user-guide/setup/install/) just run:
```bash
kubectl krew install flame
```
### Pre-built binaries
See the release page for the full list of pre-built assets.
## How it works
`kubectl-flame` launch a Kubernetes Job on the same node as the target pod.
Under the hood `kubectl-flame` use [async-profiler](https://github.com/jvm-profiling-tools/async-profiler) in order to generate flame graphs for Java applications.
Interaction with the target JVM is done via a shared `/tmp` folder.
Golang support is based on [ebpf profiling](https://en.wikipedia.org/wiki/Berkeley_Packet_Filter).
Python support is based on [py-spy](https://github.com/benfred/py-spy).
Ruby support is based on [rbspy](https://rbspy.github.io/).
NodeJS support is based on [perf](https://perf.wiki.kernel.org/index.php/Main_Page). In order for Javascript Symbols to be resolved, node process needs to be run with `--perf-basic-prof` flag.
## Contribute
Please refer to [the contributing.md file](Contributing.md) for information about how to get involved. We welcome issues, questions, and pull requests.
## Maintainers
- Eden Federman: [email protected]
## License
This project is licensed under the terms of the [Apache 2.0](LICENSE-Apache-2.0) open source license. Please refer to [LICENSE](LICENSE) for the full terms.