{"id":19173968,"url":"https://github.com/vokash3/locustexporter","last_synced_at":"2025-05-07T18:20:26.191Z","repository":{"id":229671383,"uuid":"756349370","full_name":"vokash3/LocustExporter","owner":"vokash3","description":"It's a Locust's metrics exporter for Prometheus","archived":false,"fork":false,"pushed_at":"2024-10-22T08:36:45.000Z","size":1922,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-20T00:38:29.239Z","etag":null,"topics":["dockerfile","grafana","locust","locust-dashboard","locust-exporter","locustio","monitoring","prometheus","prometheus-client"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vokash3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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,"zenodo":null}},"created_at":"2024-02-12T13:50:24.000Z","updated_at":"2025-04-17T14:10:02.000Z","dependencies_parsed_at":"2024-08-07T23:06:18.631Z","dependency_job_id":"e9b3b815-1341-41b6-9242-94d7fce9cdff","html_url":"https://github.com/vokash3/LocustExporter","commit_stats":null,"previous_names":["vokash3/locustexporter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vokash3%2FLocustExporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vokash3%2FLocustExporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vokash3%2FLocustExporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vokash3%2FLocustExporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vokash3","download_url":"https://codeload.github.com/vokash3/LocustExporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252931761,"owners_count":21827160,"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":["dockerfile","grafana","locust","locust-dashboard","locust-exporter","locustio","monitoring","prometheus","prometheus-client"],"created_at":"2024-11-09T10:15:34.508Z","updated_at":"2025-05-07T18:20:26.163Z","avatar_url":"https://github.com/vokash3.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Locust Prometheus Exporter\n\n_Compatible with Locust 2.29.1_\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/vokash3/locust_exporter.svg)](https://hub.docker.com/r/vokash3/locust_exporter/tags)\n\nInspired by [ContainerSolutions/locust_exporter](https://github.com/ContainerSolutions/locust_exporter)\nand [mbolek/locust_exporter](https://github.com/mbolek/locust_exporter)\n\n*This is a [Locust](https://github.com/locustio/locust) exporter\nfor [Prometheus](https://github.com/prometheus/prometheus) made on Python.*\n\n[![Grafana Screen](screens/locust_monitoring.png)](https://grafana.com/grafana/dashboards/20462-locust-prometheus-monitoring-modern/)\n\n## Requirements\n\nFor the best experience of using this exporter you need to be installed:\n\n1. [Prometheus](https://prometheus.io/download/)\n2. [Grafana](https://grafana.com/grafana/download?pg=get\u0026plcmt=selfmanaged-box1-cta1)\n3. [Python 3.10-3.12](https://www.python.org/downloads/)\n4. *(Optional)* [Docker](https://docs.docker.com/desktop/)\n\n## Quick Start\n\n1. Start Locust (you can use legacy and modern UI, but I prefer Legacy)\n2. Modify ``prometheus.yml`` and start Prometheus:\n    ```\n   - job_name: 'locust'\n\n    scrape_interval: 2s\n    scrape_timeout: 2s\n    static_configs:\n      - targets: ['\u003cexporter_host\u003e:\u003cexporter_port\u003e']\n   ```\n2. Configure ``config.json`` in the root of this project as you need:\n    - port – on this port export will start (this port also should be used in ``prometheus.yml``)\n    - host – where Locust is up\n3. Run\n    ```bash\n    python3 LocustExporter.py --config config.json\n    ```\n4. Use this [Grafana Dashboard](https://grafana.com/grafana/dashboards/20462-locust-prometheus-monitoring-modern/) to\n   watch your Locust.\n\n## (Alternative) Quick Start With Docker\n\nComplete the first two steps from the previous section (Quick Start) and then use this:\n[Docker Hub](https://hub.docker.com/r/vokash3/locust_exporter) or use ``Dockerfile`` in the root of this project.\n\n## (Alternative) An Extremely Fast Solution [Docker Compose]\n\nIf you don't want to worry about anything you really should try out this way!\n\n_First of all, you need docker installed in your system!_\n\nWhen all is ready follow this steps:\n\n- clone or download this project\n- go to *docker* dir of the project\n   ```bash\n  cd docker\n  ```\n- Using your editor (vim, nano ...) change **LOCUST_HOST** in *locust_exporter* block of **docker-compose.yml** to desired one\n\n    - if your Locust is up on localhost you don't need to edit this file (pass edit step)\n- run docker compose up (first time)\n   ```bash\n  docker compose up -d\n  ```\n  OR (if U need to rebuild existing containers with new configs)\n   ```bash\n  docker compose up -d --remove-orphans\n  ```\n- ENJOY IT ;-)\n\n### Used ports\n\n- 3000/tcp - grafana\n- 9090/tcp - prometheus\n- 9191/tcp - locust_exporter\n\n*In order to change them, edit configs!*\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvokash3%2Flocustexporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvokash3%2Flocustexporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvokash3%2Flocustexporter/lists"}