Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/containersolutions/locust_exporter
A Locust metrics exporter for Prometheus
https://github.com/containersolutions/locust_exporter
golang grafana locust locust-dashboard locust-exporter locustio prometheus-exporter
Last synced: about 4 hours ago
JSON representation
A Locust metrics exporter for Prometheus
- Host: GitHub
- URL: https://github.com/containersolutions/locust_exporter
- Owner: ContainerSolutions
- License: apache-2.0
- Created: 2019-09-05T14:28:01.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T11:23:47.000Z (6 months ago)
- Last Synced: 2024-08-02T15:48:07.111Z (3 months ago)
- Topics: golang, grafana, locust, locust-dashboard, locust-exporter, locustio, prometheus-exporter
- Language: Go
- Homepage: https://blog.container-solutions.com/how-to-move-metrics-from-locust.io-to-grafana-via-prometheus
- Size: 839 KB
- Stars: 108
- Watchers: 28
- Forks: 34
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Locust Exporter
Prometheus exporter for [Locust](https://github.com/locustio/locust). This exporter was inspired by [mbolek/locust_exporter](https://github.com/mbolek/locust_exporter).
[](https://hub.docker.com/r/containersol/locust_exporter/tags) [](https://github.com/ContainerSolutions/locust_exporter/blob/master/LICENSE)
## Quick Start
This package is available for Docker:
1. Run Locust ([example docker-compose](https://github.com/locustio/locust/blob/master/examples/docker-compose/docker-compose.yml))
2. Run Locust Exporter
with docker:
```bash
docker run --net=host containersol/locust_exporter
```
or with docker-compose:
```yaml
version: "3.0"
services:
locust-exporter:
image: containersol/locust_exporter
network_mode: "host"
```
3. Modify `prometheus.yml` to add target to Prometheus
```yaml
scrape_configs:
- job_name: 'locust'
static_configs:
- targets: [':9646']
```
4. Add dashboard to Grafana with ID [11985](https://grafana.com/grafana/dashboards/11985)
## Building and Running
The default way to build is:
```bash
go get github.com/ContainerSolutions/locust_exporter
cd ${GOPATH-$HOME/go}/src/github.com/ContainerSolutions/locust_exporter/
go run main.go
```
### Flags
- `--locust.uri`
Address of Locust. Default is `http://localhost:8089`.
- `--locust.timeout`
Timeout request to Locust. Default is `5s`.
- `--web.listen-address`
Address to listen on for web interface and telemetry. Default is `:9646`.
- `--web.telemetry-path`
Path under which to expose metrics. Default is `/metrics`.
- `--locust.namespace`
Namespace for prometheus metrics. Default `locust`.
- `--log.level`
Set logging level: one of `debug`, `info`, `warn`, `error`, `fatal`
- `--log.format`
Set the log output target and format. e.g. `logger:syslog?appname=bob&local=7` or `logger:stdout?json=true`
Defaults to `logger:stderr`.
### Environment Variables
The following environment variables configure the exporter:
- `LOCUST_EXPORTER_URI`
Address of Locust. Default is `http://localhost:8089`.
- `LOCUST_EXPORTER_TIMEOUT`
Timeout reqeust to Locust. Default is `5s`.
- `LOCUST_EXPORTER_WEB_LISTEN_ADDRESS`
Address to listen on for web interface and telemetry. Default is `:9646`.
- `LOCUST_EXPORTER_WEB_TELEMETRY_PATH`
Path under which to expose metrics. Default is `/metrics`.
- `LOCUST_METRIC_NAMESPACE`
Namespace for prometheus metrics. Default `locust`.
### Grafana
The grafana dashboard has beed published with ID [11985](https://grafana.com/grafana/dashboards/11985) and was exported to [locust_dashboard.json](locust_dashboard.json).
### Screenshot
[](locust_exporter.md)
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License
Apache License. Please see [License File](LICENSE.md) for more information.