Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/991jo/srcds_exporter
an prometheus exporter for SRCDS based gameservers (like CSGO, TF2, L4D2, ...).
https://github.com/991jo/srcds_exporter
csgo css fof game-server gmod hl2dm l4d2 monitoring prometheus-exporter srcds srcds-exporter teamfortress2 tf2
Last synced: about 2 months ago
JSON representation
an prometheus exporter for SRCDS based gameservers (like CSGO, TF2, L4D2, ...).
- Host: GitHub
- URL: https://github.com/991jo/srcds_exporter
- Owner: 991jo
- Created: 2019-01-02T17:27:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-20T00:22:40.000Z (over 3 years ago)
- Last Synced: 2024-05-18T18:32:50.257Z (4 months ago)
- Topics: csgo, css, fof, game-server, gmod, hl2dm, l4d2, monitoring, prometheus-exporter, srcds, srcds-exporter, teamfortress2, tf2
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 17
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-lanparty-software - srcds_exporter (python)
README
# Prometheus SRCDS Exporter
This is an exporter for the Prometheus monitoring system.
It exports data from SRCDS Gameservers (e.g. CSGO, TF2, L4D2, ...) via rcon.
It uses the `status` and `stats` commands for this.
## Supported Servers:
- CSGO
- CSS
- L4D2
- FoF
- HL2DM
- TF2
- Gmod
## How to install:
1. `git clone https://github.com/991jo/srcds_exporter.git`
2. `cd srcds_exporter`
3. `python3 -m venv .`
4. `source bin/activate`
4. `pip install -r requirements.txt`
5. `python3 main.py`
## Multi-Server vs. Single Server Mode
Initially this software was build as an exporter which can query many servers.
This conflicts a bit with the Prometheus Exporter mentality that you should
run one exporter per instance of your application.
Also you would have to know the RCON password which would get passed around
in HTTP requests.
Therefore SRCDS Exporter now supports the single server mode.
In this mode you have to specify the ip, port and password as a start
parameter. But your HTTP requests dont need those parameters anymore.
Also the exporter does not answer requests which have those fields set.
## How to query via Prometheus:
### Multi-Server-Mode
You can use the following example config.
Please adjust the IP:port in the last row to the IP:port your exporter uses.
```
- job_name: srcds
scrape_interval: 5s
metrics_path: /metrics
static_configs:
- targets: ["::"]
relabel_configs:
- source_labels: [__address__]
regex: "(.+:.+):.+"
replacement: "$1"
target_label: __param_target
- source_labels: [__address__]
regex: ".+:.+:(.+)"
replacement: "$1"
target_label: __param_password
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: 127.0.0.1:9591 # The real ip/port of the srcds_exporter
```
Basically you have to build this URL:
`http://:9591/metrics?target=:&password=`
You can use this URL for debugging purposes ;)
### Single-Server-Mode
For the single server mode you have to specify the parameters on the commandline.
python3 main.py --server_address --server_port --password
Your Prometheus config could look like this:
```
- job_name: srcds
scrape_interval: 5s
metrics_path: /metrics
static_configs:
- targets: [":"]
```
## Known issues
Some servers do not respond to RCON while changing maps.
This results in timeouts and connection errors for the exporter.
This means that you won't get data while the server changes the map.
This is okay because many of the metrics are irrelevant during map change anyway
(e.g. the server FPS rate).
## Getting Help
For a list of the commandline arguments start the exporter with the `--help`
flag.
If you have other problems, feel free to open an issue.
## TODO
- [x] make example config for Prometheus
- [ ] investigate aiorcon not timing out properly
- [x] make ip and port configurable
- [ ] add a systemd unit file
## Docker Support
The Dockerfile was added by [https://github.com/xvzf]. Thanks for that.
I am not using docker, I can not give you support on that.
## More information
I wrote a blog post about this exporter. You can find it [here](http://swagspace.org/posts/srcds-exporter.html)
## Further information regarding var, varms and sv
(https://www.reddit.com/r/GlobalOffensive/comments/23zt18/explanation_of_the_new_net_graph_thanks_vitaliy/)