Supabase OTel Assets Package initial draft #20265
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. 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. 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,16 @@ | ||
| # Supabase OpenTelemetry Assets | ||
|
|
||
| This package provides Kibana Assets for visualizing Supabase metrics collected by the **Supabase** integration. | ||
|
|
||
| ## Dashboards | ||
|
|
||
| | Dashboard | Description | | ||
| |---|---| | ||
| | **[Supabase OTel] Node & Infrastructure** | Node-level infrastructure metrics including memory, network, CPU, disk I/O, and filesystem. | | ||
| | **[Supabase OTel] Databases & PostgreSQL** | Database internals, PgBouncer connection pooling, Go SQL connection pool, and replication & WAL. | | ||
| | **[Supabase OTel] Services & API** | Application service metrics for Auth (GoTrue), PostgREST, Realtime, and Go runtime. | | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Install the **Supabase** integration package and configure it with your Supabase project credentials. These dashboards query data collected by that integration. | ||
| - Data must be ingested into the `metrics-supabase.metrics.otel-*` index pattern before the dashboards will populate. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| format_version: "3.6.2" | ||
| name: supabase_otel | ||
| title: "Supabase OpenTelemetry Assets" | ||
| version: 0.1.0 | ||
| description: >- | ||
| Visualizing Supabase metrics collected via the OTel Prometheus receiver. Covers infrastructure, PostgreSQL, Supavisor, and application service metrics. | ||
| type: content | ||
|
ishleenk17 marked this conversation as resolved.
|
||
| categories: | ||
| - observability | ||
| - monitoring | ||
| - cloud | ||
| - opentelemetry | ||
| conditions: | ||
| kibana: | ||
| version: "^9.4.0" | ||
| elastic: | ||
| subscription: basic | ||
| screenshots: | ||
| - src: /img/node_infrastructure_1.png | ||
| title: Node & Infrastructure | ||
| size: 600x600 | ||
| type: image/png | ||
| - src: /img/node_infra_2.png | ||
| title: Node & Infrastructure - Disk I/O & Filesystem | ||
| size: 600x600 | ||
| type: image/png | ||
| - src: /img/databases_postgresql.png | ||
| title: Databases & PostgreSQL | ||
| size: 600x600 | ||
| type: image/png | ||
| - src: /img/services_api.png | ||
| title: Services & API | ||
| size: 600x600 | ||
| type: image/png | ||
| icons: | ||
| - src: /img/supabase-logo.svg | ||
| title: Supabase logo | ||
| size: 256x256 | ||
| type: image/svg+xml | ||
|
ishleenk17 marked this conversation as resolved.
|
||
| discovery: | ||
| datasets: | ||
| - name: supabase.metrics.otel | ||
| owner: | ||
| type: elastic | ||
| github: elastic/obs-infraobs-integrations | ||
Uh oh!
There was an error while loading. Please reload this page.