-
- Notifications
You must be signed in to change notification settings - Fork 10.9k
docs: revamp metrics guide #40984
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.
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
base: master
Are you sure you want to change the base?
docs: revamp metrics guide #40984
Conversation
| This pull request has been ignored for the connected project Preview Branches by Supabase. |
| The latest updates on your projects. Learn more about Vercel for GitHub.
7 Skipped Deployments
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
rdjsonl
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Kubernetes (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| Self-hosting <a href="https://prometheus.io/docs/prometheus/latest/installation/" target="_blank" rel="noreferrer">Prometheus</a> and Grafana gives you full control over retention, alert routing, and dashboards. The Supabase Metrics API slots into any standard Prometheus scrape job, so you can run everything locally, on a VM, or inside Kubernetes. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule002AdmonitionTypes] Allowed admonition types are: note, tip, caution, deprecation, danger. Got: "info". (configure rule at supa-mdx-lint.config.toml)
| <Admonition type="info"> |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Alertmanager (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| 3. (Optional) **Alertmanager** or your preferred system sends notifications when Prometheus rules fire. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Alertmanager (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - Route notifications via Alertmanager, Grafana OnCall, PagerDuty, or any other supported destination. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: OnCall (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - Route notifications via Alertmanager, Grafana OnCall, PagerDuty, or any other supported destination. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: PagerDuty (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - Route notifications via Alertmanager, Grafana OnCall, PagerDuty, or any other supported destination. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: VictoriaMetrics (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| The Supabase Metrics API is intentionally vendor-agnostic. Any collector that can scrape a Prometheus text endpoint over HTTPS can ingest the data. This guide explains the moving pieces so you can adapt them to AWS Managed Prometheus, Grafana Mimir, VictoriaMetrics, Thanos, or any other system. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Thanos (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| The Supabase Metrics API is intentionally vendor-agnostic. Any collector that can scrape a Prometheus text endpoint over HTTPS can ingest the data. This guide explains the moving pieces so you can adapt them to AWS Managed Prometheus, Grafana Mimir, VictoriaMetrics, Thanos, or any other system. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: VictoriaMetrics (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **Collector** – Prometheus, Grafana Agent, VictoriaMetrics agent, Mimir scraper, etc. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Thanos (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **Long-term store (optional)** – Managed Prometheus, Thanos, Mimir, VictoriaMetrics. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: VictoriaMetrics (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **Long-term store (optional)** – Managed Prometheus, Thanos, Mimir, VictoriaMetrics. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Datadog (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **Visualization/alerting** – Grafana, Datadog, New Relic, custom code. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Distro (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **AWS Managed Prometheus (AMP):** deploy the Grafana Agent or AWS Distro for OpenTelemetry (ADOT) in your VPC, then remote-write the scraped metrics into AMP. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: VictoriaMetrics (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - **VictoriaMetrics / Mimir:** reuse the same scrape block; configure remote-write or retention rules as needed. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: PagerDuty (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - Pipe alerts into PagerDuty, Slack, Opsgenie, or any other compatible target. |
🚫 [rdjsonl] reported by reviewdog 🐶
[Rule003Spelling] Word not found in dictionary: Opsgenie (configure rule at supa-mdx-lint/Rule003Spelling.toml)
| - Pipe alerts into PagerDuty, Slack, Opsgenie, or any other compatible target. |
I have read the CONTRIBUTING.md file.
YES
What kind of change does this PR introduce?
docs update
What is the current behavior?
Metrics API page is just very verbose and not easy to parse in a choose your own destiny kind of way
What is the new behavior?
IMHO :D a bit more user friendly
Additional context
Inital preview of Metrics API home