{"id":18384962,"url":"https://github.com/allegro/envoy-perf-pprof","last_synced_at":"2025-04-11T23:49:34.775Z","repository":{"id":43026031,"uuid":"344831149","full_name":"allegro/envoy-perf-pprof","owner":"allegro","description":"Convenient Envoy on-CPU performance analysis with perf and pprof.","archived":false,"fork":false,"pushed_at":"2022-03-22T18:40:26.000Z","size":505,"stargazers_count":13,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T23:49:28.783Z","etag":null,"topics":["cpu","envoy","perf","pprof","profiling"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allegro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-05T14:11:43.000Z","updated_at":"2024-01-16T12:46:57.000Z","dependencies_parsed_at":"2022-09-14T22:03:10.290Z","dependency_job_id":null,"html_url":"https://github.com/allegro/envoy-perf-pprof","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allegro%2Fenvoy-perf-pprof","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allegro%2Fenvoy-perf-pprof/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allegro%2Fenvoy-perf-pprof/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allegro%2Fenvoy-perf-pprof/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allegro","download_url":"https://codeload.github.com/allegro/envoy-perf-pprof/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497890,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpu","envoy","perf","pprof","profiling"],"created_at":"2024-11-06T01:15:58.562Z","updated_at":"2025-04-11T23:49:34.752Z","avatar_url":"https://github.com/allegro.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# envoy-perf-pprof\n\n\u003e Convenient Envoy on-CPU performance analysis with perf and pprof.\n\n`envoy-perf-pprof` takes `perf` data collected for an Envoy process and launches [pprof](https://github.com/google/pprof/) for it.\nTakes care of installing required dependencies in Docker and handling Envoy symbolization.\n\n## Example\n\nCall `./envoy-perf-pprof.sh v1.17.0 example/example.perf` to play with an example profile.\n\n![Envoy flamegraph example](example/example.png \"Envoy flamegraph example\")\n\n## Usage\n\n### Collect `perf` data\n\nRun `perf` on the machine running an official Envoy binary, e.g. a 10 minutes profile, as described\nin [Envoy docs](https://github.com/envoyproxy/envoy/blob/main/bazel/PPROF.md#on-cpu-analysis):\n\n```bash\n$ perf record -F 49 -g -o /tmp/envoy.perf -p \u003cenvoy-pid\u003e -- sleep 600\n[ perf record: Woken up 1 times to write data ]\n[ perf record: Captured and wrote 0.694 MB /tmp/envoy.perf (1532 samples) ]\n```\n\n### Analyse with `envoy-perf-pprof`\n\nExecute `./envoy-perf-pprof.sh` with profiled Envoy version and perf data file as arguments, e.g.:\n\n```bash\n$ ./envoy-perf-pprof.sh v1.17.0 envoy.perf\n(...)\nServing web UI on http://0.0.0.0:8888\n```\n\nOpen the link in the browser to access [pprof](https://github.com/google/pprof/) web UI.\n\nThe first run will take a few of minutes as it builds the Docker image: installs dependencies and\ndownloads proper Envoy version with debug symbols retained.\n\n## Alternatives\n\nInstead of profiling with `perf` and `envoy-perf-pprof` you can compile Envoy with `gperftools` by yourself and use it instead of the official binaries.\nThis path is described in\n[Envoy docs](https://github.com/envoyproxy/envoy/blob/main/bazel/PPROF.md#cpu-or-memory-consumption-testing-with-gperftools-and-pprof).\nIt allows you to profile both CPU and memory.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallegro%2Fenvoy-perf-pprof","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallegro%2Fenvoy-perf-pprof","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallegro%2Fenvoy-perf-pprof/lists"}