Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tobbbles/prometheus-teamspeak
A Prometheus metric server for monitoring TeamSpeak3 servers
https://github.com/tobbbles/prometheus-teamspeak
Last synced: about 6 hours ago
JSON representation
A Prometheus metric server for monitoring TeamSpeak3 servers
- Host: GitHub
- URL: https://github.com/tobbbles/prometheus-teamspeak
- Owner: tobbbles
- Created: 2016-02-26T16:08:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-08-01T23:13:50.000Z (over 8 years ago)
- Last Synced: 2023-03-02T16:23:04.373Z (over 1 year ago)
- Language: Go
- Homepage: https://hub.docker.com/r/mnzt/prometheus-teamspeak/
- Size: 6.22 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Prometheus monitor for TeamSpeak3
A simple [Prometheus](https://prometheus.io) tool for checking the status of a TeamSpeak3 server via pinging the ServerQuery port.
This is a GB-style project. You can [get GB here](https://getgb.io)
## Installing:
```
git clone https://github.com/mnzt/prometheus-teamspeak
cd prometheus-teamspeak
gb build
./bin/prometheus-teamspeak
```
## Usage
There are three environmental variables utilised:
- Address - The address of your TeamSpeak3 server (Be sure to specify the port with a colon).
`export ADDR="localhost:10011"`
- Interval (optional) - How often the TeamSpeak3 server is pinged.
`export INTERVAL=5`
- Port (optional) - The port on which this service runs on.
`export PORT=8010`
### Manually via binary
Simply specify the envvars above and run the service via `./bin/prometheus-teamspeak`.
Visiting [http://localhost:8010/metrics](http://127.0.0.1:8010/metrics) in your browser should present you with the metrics (if you specified a different port, navigate to that URL instead.)
### Via Docker
1. Pull the docker image via `docker pull mnzt/prometheus-teamspeak`
- Alternatively build the image from source with `docker build -t prometheus-teamspeak .`
2. Run the container, ensuring to specify the environment variables. _NOTE:_ If you are running a TeamSpeak3 server and prometheus-teamspeak on the same host, be sure to set `--net=host`.
```
docker run -d \
-e ADDR=ts.awesome.server:10011 \
-e INTERVAL=5 \
-p 1337:8010 \
prometheus-teamspeak
```