-
Notifications
You must be signed in to change notification settings - Fork 619
Supabase OTel Assets Package initial draft #20265
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
Changes from 10 commits
7113490
547e135
01a610c
0583aa8
8d6cd21
00621bc
02a7980
2c00510
a45c483
c741d96
eac29d9
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # newer versions go on top | ||
| - version: "0.1.0" | ||
| changes: | ||
| - description: Initial release of the Supabase content package with three Kibana dashboards | ||
| type: enhancement | ||
| link: https://github.com/elastic/integrations/pull/20265 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The docs/README.md appears to have been written by hand rather than generated from a _dev/build/docs/README.md template (the auto-generated header is absent, and there is no _dev/build/docs/ directory in the package). As a result, the structure diverges significantly from both the elastic-package archetype template and the convention established by peer OTel content packages such as cassandra_otel. The current file covers only a dashboard list and a short prerequisites note, but is missing the sections that are standard across comparable packages: an opening overview paragraph describing Supabase and the metrics scope, a Compatibility section stating which Supabase and OTel collector versions were tested, a Requirements section (Elasticsearch + Kibana), and a Setup section with the OTel collector configuration (Prometheus receiver YAML) that users need to actually route data into metrics-supabase.metrics.otel-*. Adding the _dev/build/docs/README.md template and regenerating via elastic-package build would also make future updates easier to maintain consistently.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. content packages currently don't support this auto geenrated approach. Anyhow I have now updated to use that structure. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # Supabase OpenTelemetry Assets | ||
|
|
||
| Supabase is an open-source Firebase alternative built on top of PostgreSQL, offering authentication, real-time subscriptions, RESTful APIs, and connection pooling as managed services. | ||
|
|
||
| This content package provides dashboards for Supabase projects monitored via the OpenTelemetry Prometheus receiver. The assets cover three observability tiers: node infrastructure, PostgreSQL database internals, and application services (GoTrue, PostgREST, Realtime). | ||
|
|
||
|
|
||
| ## Requirements | ||
|
|
||
| You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| 1. A Supabase project with the Observability endpoint enabled. The endpoint exposes Prometheus-format metrics for infrastructure, PostgreSQL, and application services. | ||
|
|
||
| 2. Install the **Supabase** integration package and configure it with your Supabase project credentials. This content package provides dashboards that visualize data collected by that integration. | ||
|
|
||
| ### Configuration | ||
|
|
||
| Configure the Supabase Integration Package to scrape your Supabase Prometheus endpoint and export to Elasticsearch. | ||
|
|
||
| | Placeholder | Description | Example | | ||
| |-------------|-------------|---------| | ||
| | `<SUPABASE_METRICS_ENDPOINT>` | Supabase project Observability metrics endpoint | `https://<project-ref>.supabase.co/customer/v1/privileged/metrics` | | ||
| | `<SUPABASE_SERVICE_KEY>` | Supabase service role API key for authentication | `eyJhbGciOiJIUzI1NiIs...` | | ||
|
|
||
|
|
||
| ## Dashboards | ||
|
|
||
| | Dashboard | Description | | ||
| |-----------|-------------| | ||
| | **[Supabase OTel] Node & Infrastructure** | Node-level infrastructure metrics including CPU, memory, disk I/O, filesystem, and network. | | ||
| | **[Supabase OTel] Databases & PostgreSQL** | PostgreSQL internals, PgBouncer connection pooling, Go SQL connection pool, replication, and WAL. | | ||
| | **[Supabase OTel] Services & API** | Application service metrics for Auth (GoTrue), PostgREST, Realtime, and Go runtime. | |
Uh oh!
There was an error while loading. Please reload this page.