go/sliding-sync
go/sliding-sync
1
0
Fork 0
mirror of https://github.com/matrix-org/sliding-sync.git synced 2025-03-10 13:37:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #428 from matrix-org/grafana-dashboard

Browse Source 
Add grafana dashboard for SS proxy
This commit is contained in:
Kegan Dougal 2024-05-30 13:31:45 +01:00 committed by GitHub
commit 5da6865609
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2138 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
grafana/README.md Normal file
View File

@ -0,0 +1,18 @@
# Using the Sliding Sync Grafana dashboard
**Set up Prometheus and Grafana.** Out of scope for this readme. Useful documentation about using Grafana with Prometheus: http://docs.grafana.org/features/datasources/prometheus/
**Configure the bind address** for prometheus metrics in sliding sync. For example: `SYNCV3_PROM=:2112`. Metrics will be accessible at `/metrics` at this address.
**Configure a new job in Prometheus** to scrape the sliding sync endpoint.
For example by adding the following job to `prometheus.yml`, if your sliding sync is running locally not in docker and you have `SYNCV3_PROM` configured to port 2112:
```
# Sliding Sync
- job_name: "Sliding Sync"
static_configs:
- targets: ["localhost:2112"]
```
**Import the sliding sync dashboard into Grafana.** Download `sliding-sync.json`. Import it to Grafana and select the correct Prometheus datasource. http://docs.grafana.org/reference/export_import/

2120
grafana/sliding-sync.json Normal file
View File

File diff suppressed because it is too large Load Diff