Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,7 @@
/packages/statsd_input_otel @elastic/ecosystem
/packages/stormshield @elastic/integration-experience
/packages/sublime_security @elastic/security-service-integrations @elastic/sit-crest-contractors
/packages/supabase_otel @elastic/obs-infraobs-integrations
/packages/suricata @elastic/integration-experience
/packages/swimlane @elastic/security-service-integrations @elastic/sit-crest-contractors
/packages/symantec_endpoint @elastic/integration-experience
Expand Down
6 changes: 6 additions & 0 deletions packages/supabase_otel/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# newer versions go on top

Check notice on line 1 in packages/supabase_otel/changelog.yml

View workflow job for this annotation

GitHub Actions / Lint user-facing content

Elastic.Versions: Use 'later versions' instead of 'newer versions' when referring to versions.
- version: "0.1.0"
changes:
- description: Initial release of the Supabase content package with three Kibana dashboards
type: enhancement
Comment thread
ishleenk17 marked this conversation as resolved.
link: https://github.com/elastic/integrations/pull/20265
36 changes: 36 additions & 0 deletions packages/supabase_otel/docs/README.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content packages currently don't support this auto geenrated approach.
We should add that in pakcgae spec.

Anyhow I have now updated to use that structure.
Please check

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. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/supabase_otel/img/node_infra_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/supabase_otel/img/services_api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions packages/supabase_otel/img/supabase-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading