certusone
/
wormhole
mirror of https://github.com/certusone/wormhole.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add section to the ops docs on telemetry 

This shows new guardians how to enable telemetry.
This commit is contained in:
Jeff Schroeder 2024-04-04 18:09:04 -04:00
parent 62a82b86ae
commit 188e3cc475
No known key found for this signature in database
GPG Key ID: C05253F844F9013E
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/operations.md
View File

@ -228,6 +228,17 @@ It is safe to expose the publicWeb port on signing nodes. For better resiliency
future guardiand releases will include listen-only mode such that multiple guardiand instances without guardian keys
can be operated behind a load balancer.
## Enabling Telemetry
Optionally, the guardian can send telemetry to [grafana cloud logs](https://grafana.com/products/cloud/logs/) aka "loki".
To enable this functionality, add the following flag:
```bash
--telemetryLokiURL=$PER_GUARDIAN_LOKI_URL_WITH_TOKEN
```
New guardians should talk to the wormhole foundation to get a loki url.
### Binding to privileged ports
If you want to bind `--publicWeb` to a port <1024, you need to assign the CAP_NET_BIND_SERVICE capability.