Telemetry
Integration guide

Supabase And Postgres App Telemetry

Track product workflows, database-adjacent jobs, API routes, and customer-facing failures from server code.

Reviewed by the Telemetry product team on . Instrumentation contract, privacy boundaries, and implementation guidance. Review standards and ownership

Useful for
  • API reliability
  • Activation tracking
  • Operational debugging
Implementation evidence

Supabase And Postgres App Telemetry: from boundary to verified row

Use Supabase And Postgres App Telemetry at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

  1. 1

    Choose the outcome

    API reliability

  2. 2

    Define the contract

    function_name, route_template, method, status_code, and region

  3. 3

    Instrument the boundary

    Keep the Telemetry key and Supabase secret or service-role credentials in server-side function secrets; never expose them to browser code.

  4. 4

    Verify the evidence

    Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

Prerequisites and boundaries

  • A Supabase Edge Function or other trusted server runtime with a Telemetry secret
  • Row Level Security and application authorization enforced before privileged database work
  • A pooled or serverless-friendly Postgres connection path for direct database access

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

supabase-postgres-install

npm installation

bash
npm install telemetry-sh
  1. 1Prepare one reusable server-side delivery client with bounded network behavior.
  2. 2Add the outcome event at the success, failure, retry, or timeout boundary.
  3. 3Send controlled fixtures and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

supabase-postgres

Supabase And Postgres App Telemetry event

javascript
await telemetry.log("api_request_completed", {
  function_name: "sync-project",
  route_template: "/api/projects/:id/sync",
  method: "POST",
  status_code: 200,
  status: "success",
  latency_ms: 266,
  database_operation: "sync_project",
  team_id: team.id,
  region: Deno.env.get("SB_REGION"),
});

Event contract

function_name, route_template, method, status_code, and region

status, latency_ms, database_operation, rows_affected, and error_type

request_id, account_id, release, and environment

Implementation checkpoints

Checkpoint 1

Keep the Telemetry key and Supabase secret or service-role credentials in server-side function secrets; never expose them to browser code.

Checkpoint 2

Log the application outcome rather than SQL text, connection strings, request bodies, or unrestricted database errors.

Checkpoint 3

Separate function latency from database-operation latency when the distinction is needed for diagnosis.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

supabase-postgres-verification

Supabase And Postgres App Telemetry verification query

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.
Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.
Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.
Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Production boundary

Keep the outcome event small and recoverable

This pattern provides

  • A bounded, SQL-ready outcome beside the upstream workflow.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • A fixture-driven path for validating success, failure, retry, and timeout behavior.

This pattern does not provide

  • An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
  • Exactly-once delivery merely because the payload contains an event ID.
  • Permission to collect raw provider payloads, user content, credentials, or regulated data.

Event schema starting points

Review the row grain, emit boundary, required types, privacy classes, example payload, and validation checklist before adapting a query or snippet to production.

Related product capability

Continue this workflow in Dashboards

Turn a validated product or revenue query into a focused decision surface.

Related SQL recipes

Answer the next question with SQL

Run the query against the structured fields from this workflow, inspect the example result, and turn a useful answer into a dashboard or alert.

Browse all recipes

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations