Gabriel Simmer
d4cffaea0a
Rather than having configuration file based instance list. Having both is an option but the trend is generally using group instances for events.
26 lines
940 B
Markdown
26 lines
940 B
Markdown
VR Event Tracker
|
|
===
|
|
|
|
Adapter for VRChat API instance data and VRCDN API to Prometheus metrics.
|
|
|
|
Very budget version of [VEMS](https://github.com/kakious/vems-monitor), which can be viewed as a more
|
|
complete solution. This is mostly for fun and learning. A dashboard is provided in `grafana/dashboard.json`.
|
|
|
|
Not a lot of metrics are collected at the moment. Just the ones I care about.
|
|
|
|
## Configuration
|
|
|
|
Configuration is done with a `config.toml` file with the following format:
|
|
|
|
```toml
|
|
group = "group_7f23c663-e3c5-408f-bfb3-02b164f9e921"
|
|
vrcdn = "vrcdn_stream_name"
|
|
```
|
|
|
|
Instances will be retrieved from the group.
|
|
|
|
Runs on port `6534`, on all interfaces. May be configurable in the future.
|
|
|
|
You will need to set the `VRCHAT_AUTH_TOKEN` environment variable to authenticate with VRChat's API. This isn't technically
|
|
recommended and a more robust authentication system (see: _correct_) should be considered for serious use (see: VEMS).
|