{"id":18299642,"url":"https://github.com/containersolutions/locust_exporter","last_synced_at":"2025-04-05T13:35:08.071Z","repository":{"id":39975375,"uuid":"206583809","full_name":"ContainerSolutions/locust_exporter","owner":"ContainerSolutions","description":"A Locust metrics exporter for Prometheus","archived":false,"fork":false,"pushed_at":"2024-04-25T11:23:47.000Z","size":859,"stargazers_count":108,"open_issues_count":10,"forks_count":34,"subscribers_count":28,"default_branch":"main","last_synced_at":"2024-08-02T15:48:07.111Z","etag":null,"topics":["golang","grafana","locust","locust-dashboard","locust-exporter","locustio","prometheus-exporter"],"latest_commit_sha":null,"homepage":"https://blog.container-solutions.com/how-to-move-metrics-from-locust.io-to-grafana-via-prometheus","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/ContainerSolutions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2019-09-05T14:28:01.000Z","updated_at":"2024-07-19T13:42:18.000Z","dependencies_parsed_at":"2024-01-07T16:32:32.565Z","dependency_job_id":"33b99446-19e5-4aa5-8a38-6826b0f08286","html_url":"https://github.com/ContainerSolutions/locust_exporter","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Flocust_exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Flocust_exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Flocust_exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ContainerSolutions%2Flocust_exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ContainerSolutions","download_url":"https://codeload.github.com/ContainerSolutions/locust_exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223192565,"owners_count":17103564,"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":["golang","grafana","locust","locust-dashboard","locust-exporter","locustio","prometheus-exporter"],"created_at":"2024-11-05T15:09:42.776Z","updated_at":"2024-11-05T15:09:43.563Z","avatar_url":"https://github.com/ContainerSolutions.png","language":"Go","readme":"# Locust Exporter\n\nPrometheus exporter for [Locust](https://github.com/locustio/locust). This exporter was inspired by [mbolek/locust_exporter](https://github.com/mbolek/locust_exporter).\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/containersol/locust_exporter.svg)](https://hub.docker.com/r/containersol/locust_exporter/tags) [![license](https://img.shields.io/github/license/ContainerSolutions/locust_exporter.svg)](https://github.com/ContainerSolutions/locust_exporter/blob/master/LICENSE)\n\n![locust_dashboard](locust_dashboard.png)\n\n## Quick Start\n\nThis package is available for Docker:\n\n1. Run Locust ([example docker-compose](https://github.com/locustio/locust/blob/master/examples/docker-compose/docker-compose.yml))\n\n2. Run Locust Exporter\n\n    with docker:\n\n    ```bash\n    docker run --net=host containersol/locust_exporter\n    ```\n\n    or with docker-compose:\n\n    ```yaml\n    version: \"3.0\"\n\n    services:\n      locust-exporter:\n        image: containersol/locust_exporter\n        network_mode: \"host\"\n    ```\n\n3. Modify `prometheus.yml` to add target to Prometheus\n\n    ```yaml\n    scrape_configs:\n      - job_name: 'locust'\n        static_configs:\n          - targets: ['\u003cLOCUST_IP\u003e:9646']\n    ```\n\n4. Add dashboard to Grafana with ID [11985](https://grafana.com/grafana/dashboards/11985)\n\n## Building and Running\n\nThe default way to build is:\n\n```bash\ngo get github.com/ContainerSolutions/locust_exporter\ncd ${GOPATH-$HOME/go}/src/github.com/ContainerSolutions/locust_exporter/\ngo run main.go\n```\n\n### Flags\n\n- `--locust.uri`\n  Address of Locust. Default is `http://localhost:8089`.\n\n- `--locust.timeout`\n  Timeout request to Locust. Default is `5s`.\n\n- `--web.listen-address`\n  Address to listen on for web interface and telemetry. Default is `:9646`.\n\n- `--web.telemetry-path`\n  Path under which to expose metrics. Default is `/metrics`.\n\n- `--locust.namespace`\n  Namespace for prometheus metrics. Default `locust`.\n\n- `--log.level`\n  Set logging level: one of `debug`, `info`, `warn`, `error`, `fatal`\n\n- `--log.format`\n  Set the log output target and format. e.g. `logger:syslog?appname=bob\u0026local=7` or `logger:stdout?json=true`\n  Defaults to `logger:stderr`.\n\n### Environment Variables\n\nThe following environment variables configure the exporter:\n\n- `LOCUST_EXPORTER_URI`\n  Address of Locust. Default is `http://localhost:8089`.\n\n- `LOCUST_EXPORTER_TIMEOUT`\n  Timeout reqeust to Locust. Default is `5s`.\n\n- `LOCUST_EXPORTER_WEB_LISTEN_ADDRESS`\n  Address to listen on for web interface and telemetry. Default is `:9646`.\n\n- `LOCUST_EXPORTER_WEB_TELEMETRY_PATH`\n  Path under which to expose metrics. Default is `/metrics`.\n\n- `LOCUST_METRIC_NAMESPACE`\n  Namespace for prometheus metrics. Default `locust`.\n\n### Grafana\n\nThe grafana dashboard has beed published with ID [11985](https://grafana.com/grafana/dashboards/11985) and was exported to [locust_dashboard.json](locust_dashboard.json).\n\n### Screenshot\n\n[![locust exporter](locust_exporter.png)](locust_exporter.md)\n\n### Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## License\n\nApache License. Please see [License File](LICENSE.md) for more information.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Flocust_exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontainersolutions%2Flocust_exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainersolutions%2Flocust_exporter/lists"}