This is a server that scrapes Teeworlds master servers and econ servers, get stats and exports them via HTTP for Prometheus consumption.
For the build, you only need the following requirements:
- Go 1.22.3
Next to the Go application you could need the following requirements:
- Teeworlds server 0.7
- With a econ server
Now you can build and run the Go application, check the -h or --help flag if needed.
The metrics are detailed below.
| Name | Description |
|---|---|
teeworlds_server_players |
Total number of players in a Teeworlds server. |
teeworlds_master_server_players |
Total number of players on a master server. |
teeworlds_master_server_servers |
Total number of servers registered on a master server. |
teeworlds_master_server_request_duration_seconds |
Request duration when refreshing a master server. From client request to full data server response. |
teeworlds_master_server_request_total |
Total number of master server requests. |
teeworlds_econ_event_total |
Total number of received econ events. |
If you want to help the project, you can follow the guidelines in CONTRIBUTING.md.
The YAML configuration is supposed to have the following format.
servers:
econ:
- host: localhost
port: 7000
password: hello_world
master:
- protocol: http
url: "https://master1.ddnet.tw/ddnet/15/servers.json"
refresh_cooldown: 10
- protocol: udp
host: "master1.teeworlds.com"
port: 8283
refresh_cooldown: 15
- protocol: udp
host: "master2.teeworlds.com"
port: 8283
refresh_cooldown: 15
- protocol: udp
host: "master3.teeworlds.com"
port: 8283
refresh_cooldown: 15
- protocol: udp
host: "master4.teeworlds.com"
port: 8283
refresh_cooldown: 15