Skip to content

Conversation

@smeubank
Copy link
Contributor

@smeubank smeubank commented Dec 2, 2025

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

  • Rebuilt the Metrics landing page as a true hub: cleaned hero copy, added the reusable , and added for the four integration paths (apps/docs/content/guides/telemetry/metrics.mdx).
  • Added dedicated sub-guides for Grafana Cloud, Grafana + self-hosted Prometheus, Datadog, and vendor-agnostic setups, each embedding the shared access section plus vendor-specific callouts (apps/docs/content/guides/telemetry/metrics/*).
  • Introduced reusable components for the access instructions and stack cards, wired them into the MDX runtime, and updated the nav constants so the new guides appear in the sidebar (apps/docs/components/MetricsAccessSection.tsx, MetricsStackCards.tsx, apps/docs/features/docs/MdxBase.shared.tsx, NavigationMenu.constants.ts).
@supabase
Copy link

supabase bot commented Dec 2, 2025

This pull request has been ignored for the connected project xguihxuzqibwxjnimxev because there are no changes detected in supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.


Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

@vercel
Copy link

vercel bot commented Dec 2, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Dec 2, 2025 7:23pm
7 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
studio Ignored Ignored Dec 2, 2025 7:23pm
cms Skipped Skipped Dec 2, 2025 7:23pm
design-system Skipped Skipped Dec 2, 2025 7:23pm
studio-self-hosted Skipped Skipped Dec 2, 2025 7:23pm
studio-staging Skipped Skipped Dec 2, 2025 7:23pm
ui-library Skipped Skipped Dec 2, 2025 7:23pm
zone-www-dot-com Skipped Skipped Dec 2, 2025 7:23pm
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 2, 2025
Copy link
Contributor

@github-actions github-actions bot left a 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)


🚫 [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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

2 participants