Agent Check: Supabase

Overview

This check monitors Supabase through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

Starting from Agent release 7.62.0, the Supabase check is included in the Datadog Agent package. No additional installation is needed in your environment.

This check uses OpenMetrics to collect metrics from the OpenMetrics endpoint that Supabase exposes, which requires Python 3.

Configuration

Supabase platform comes with a Prometheus-compatible metrics endpoint readily accessible at your project's metrics endpoint: https://<project-ref>.supabase.co/customer/v1/privileged/metrics. Access to the endpoint is secured via HTTP Basic Auth; the username is service_role, while the password is the service role JWT available through the Supabase dashboard.

## All options defined here are available to all instances.
#
init_config:

instances:

    # The endpoint exposing Supabase customer metrics
    #
  - privileged_metrics_endpoint:  https://<project-ref>.supabase.co/customer/v1/privileged/metrics

    ## @param username - string - optional
    ## The username to use if services are behind basic or digest auth.
    #
    username: service_role

    ## @param password - string - optional
    ## The password to use if services are behind basic or NTLM auth.
    #
    password: <JWT>

It also comes with a hosted Postgres database. To integrate with the Agent, you need to prepare Postgres then supply the database configuration to the integration configuration.

## All options defined here are available to all instances.
#
init_config:

instances:

    ## @param host - string - required
    ## The hostname to connect to.
    #
  - host: <HOST>

    ## @param port - integer - optional - default: 5432
    ## The port to use when connecting to PostgreSQL.
    #
    port: 6543

    ## @param username - string - required
    ## The Datadog username created to connect to PostgreSQL.
    #
    username: datadog.<PROJECT-REF>

    ## @param password - string - optional
    ## The password associated with the Datadog user.
    #
    password: <UNIQUEPASSWORD>
    
    ## @param dbname - string - optional - default: postgres
    ## The name of the PostgreSQL database to monitor.
    ## Note: If omitted, the default system Postgres database is queried.
    #
    dbname: <DATABASE>

Supabase Storage comes with a Prometheus-compatible metrics endpoint readily accessible at /metrics on port 5000. For the Agent to start collecting metrics, the Supabase Storage container needs to be annotated. For more information about annotations, refer to the Autodiscovery Integration Templates for guidance. You can find additional configuration options by reviewing the sample supabase.d/conf.yaml.

Note: Integration with Supabase Storage is only available in the self-hosted architecture. storage_api_endpoint should be set to the location where the Prometheus-formatted metrics are exposed. The default port is 5000. In containerized environments, %%host%% should be used for host autodetection.

Validation

Run the Agent's status subcommand and look for supabase under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The Supabase integration does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.