{"id":15965256,"url":"https://github.com/bwplotka/prombenchy","last_synced_at":"2025-09-05T08:31:32.418Z","repository":{"id":229852241,"uuid":"777756416","full_name":"bwplotka/prombenchy","owner":"bwplotka","description":"The simplistic and experimental alternative to beloved Prombench tool for benchmarking Prometheus based systems on Kubernetes.","archived":false,"fork":false,"pushed_at":"2024-10-15T09:20:19.000Z","size":119,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-28T19:40:22.684Z","etag":null,"topics":["kubernetes","performance","prometheus","remote-write"],"latest_commit_sha":null,"homepage":"","language":"Go","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/bwplotka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-26T13:02:16.000Z","updated_at":"2024-10-15T09:20:23.000Z","dependencies_parsed_at":"2024-05-02T15:57:16.737Z","dependency_job_id":"5a09a2bf-b5cc-4ccb-b30c-8ecced5be4f1","html_url":"https://github.com/bwplotka/prombenchy","commit_stats":null,"previous_names":["bwplotka/prombenchy"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bwplotka%2Fprombenchy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bwplotka%2Fprombenchy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bwplotka%2Fprombenchy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bwplotka%2Fprombenchy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bwplotka","download_url":"https://codeload.github.com/bwplotka/prombenchy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232031972,"owners_count":18462965,"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":["kubernetes","performance","prometheus","remote-write"],"created_at":"2024-10-07T17:40:33.086Z","updated_at":"2024-12-31T21:32:54.904Z","avatar_url":"https://github.com/bwplotka.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# prombenchy\n\nThis repo contains very simplistic, experimental and opinionated [prombench](https://github.com/prometheus/test-infra/tree/master/prombench) alternative\nthat focuses on benchmarking (and testing) the agents, so collection modes for Prometheus metrics (discovery + scrape + basic processing + remote write/alternative protocols) on GKE.\n\nFeel free to use it as you wish.\n\n## Usage\n\nCheck `make help` on what's possible. Then if anything is failing check `scripts/` bash scripts and adjust according to your setup. Those are shell script, will be always flaky for edge cases or races, but it's better than nothing (: \n\nThe general flow looks as follows:\n\n* You setup your GKE cluster once: `make cluster-setup CLUSTER_NAME=my-prombenchy`\n* Then to start any benchmark run you do `make start CLUSTER_NAME=my-prombenchy BENCH_NAME=\u003cname of benchmark, also k8s namespace\u003e SCENARIO=./manifests/scenarios/gmp`. This will setup node-pool and your collector (e.g. as daemon set or separate pod - up to you, as long as you do correct node section!)\n\n    You can start as many scenarios as you want on the single cluster (make sure to use unique `BENCH_NAME` though!). The scenario is a path to the \"collector\" manifest, so anything that will scrape `./manifests/load/avalanche.exampletarget.yaml`. Feel free to adjust anything in `./manifests/scenarios/` or add your own. You are also welcome to create custom scenarios under `scenarios/`, store them locally or propose to this repo.\n    \n    `prombenchy` setup uses separate meta-monitoring containers in `core` namespace:\n    * Separate Prometheus for gathering metrics about core resources and collectors (available locally, but also sends all to GCM). Make sure your pod has `app=collector` label and relevant port name has `-ins` suffix, to be scraped by this core Prometheus. There is also a dashboard you can apply to GCM in `./dashboards/`.\n      * Parca profiling agent scraping (30s interval) pods with `app=collector` for Go `pprof` endpoints in the default paths. Currently you need to port-forward 7070 from the pod to access profiles: `kubectl -n core port-forward pod/\u003cparca-pod-name\u003e 7070`.\n\n* `make stop CLUSTER_NAME=my-prombenchy BENCH_NAME=\u003cname of benchmark, also k8s namespace\u003e SCENARIO=./manifests/scenarios/gmp` kill the node-pool and experiment.\n\n## Bonus CLI\n\nSee [tools/mtypes](./tools/mtypes) to learn about a small CLI for gathering statistics about metric types from a given scrape page. It also can \"generate\" [avalanche](https://github.com/prometheus-community/avalanche) flags.\n\n## TODOs\n\n* [ ] All scenarios are GMP aware, so they send data to GCM. In the future, we plan to also benchmark remote-write or OTLP, but proper test reivers would need to be added. Help welcome!\n* [ ] Probably Go code for scripts instead of bash, for reliability.\n* [ ] Cleanup svc account permissions on stopped scenarios.\n* [ ] Make config-reloader work with otel-collector and parca (annoying to delete pod after config changes).\n* [ ] Public auth-ed IPs for accessing parca and prometheus details?\n\n## Credits\n\nThis repo was started by sharing a lot of design and resources from https://github.com/prometheus/test-infra repo, which we maintain in the Prometheus team mostly for [prombench](https://github.com/prometheus/test-infra/tree/master/prombench) functionality. Kudos to prombench project for the hard work so far! Since then, it was completely redesigned and simplified.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbwplotka%2Fprombenchy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbwplotka%2Fprombenchy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbwplotka%2Fprombenchy/lists"}