Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add grafana dashboard for SS proxy #428

Merged
merged 2 commits into from
May 30, 2024
Merged

Add grafana dashboard for SS proxy #428

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
718513a
Add grafana chart for SS proxy
wrjlewis May 1, 2024
62b181c
Apply suggestions from code review
wrjlewis May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions grafana/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
wrjlewis marked this conversation as resolved.
Show resolved Hide resolved

**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 and you have `SYNCV3_PROM` configured to port 2112:
wrjlewis marked this conversation as resolved.
Show resolved Hide resolved

```
# 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/
Loading
Loading