概要

このチェックは Datadog Agent を通じて Supabase を監視します。

セットアップ

ホストで実行されている Agent 用にこのチェックをインストールおよび構成する場合は、以下の手順に従ってください。コンテナ環境の場合は、オートディスカバリーのインテグレーションテンプレートのガイドを参照してこの手順を行ってください。

インストール

Agent リリース 7.62.0 以降、Supabase チェックは Datadog Agent パッケージに同梱されています。環境での追加インストールは不要です。

このチェックは OpenMetrics を使用して、Supabase が公開する OpenMetrics エンドポイントからメトリクスを収集します。Python 3 が必要です。

設定

Supabase プラットフォームには、プロジェクトの metrics エンドポイントでアクセスできる Prometheus 互換のメトリクス エンドポイントが用意されています: https://<project-ref>.supabase.co/customer/v1/privileged/metrics。エンドポイントへのアクセスは HTTP Basic 認証で保護されています。username は service_role、password は Supabase dashboard から入手可能な service role の JWT です。

## ここで定義したすべてのオプションは、すべてのインスタンスで利用できます。
#
init_config:

instances:

    # Supabase 顧客向けメトリクスを公開するエンドポイントmetrics
    #
  - privileged_metrics_endpoint:  https://<project-ref>.supabase.co/customer/v1/privileged/metrics

    ## @param username - 文字列 - 任意
    ## サービスが Basic または Digest 認証の背後にある場合に使用するユーザー名。
    #
    username: service_role

    ## @param password - 文字列 - 任意
    ## サービスが Basic または NTLM 認証の背後にある場合に使用するパスワード。
    #
    password: <JWT>

また、ホスト型の Postgres データベースも含まれます。Agent と連携するには、まず Postgres の準備 を行い、その後データベースの設定をインテグレーションの構成に指定します。

## ここで定義したすべてのオプションは、すべてのインスタンスで利用できます。
#
init_config:

instances:

    ## @param host - 文字列 - 必須
    ## 接続先のホスト名。
    #
  - host: <HOST>

    ## @param port - 整数 - 任意 - デフォルト: 5432
    ## PostgreSQL に接続する際に使用するポート。
    #
    port: 6543

    ## @param username - 文字列 - 必須
    ## PostgreSQL への接続用に作成した Datadog ユーザー名。
    #
    username: datadog.<PROJECT-REF>

    ## @param password - 文字列 - 任意
    ## Datadog ユーザーに関連付けられたパスワード。
    #
    password: <UNIQUEPASSWORD>

    ## @param dbname - 文字列 - オプション - デフォルト: postgres
    ## 監視する PostgreSQL データベース名。
    ## 注: 省略した場合、デフォルトのシステム Postgres データベースがクエリされます。
    #
    dbname: <DATABASE>

Supabase Storage には、ポート 5000 の /metrics でアクセスできる Prometheus 互換のメトリクス エンドポイントがあります。Agent がメトリクス収集を開始するには、Supabase Storage コンテナにアノテーションが必要です。アノテーションについての詳細は、Autodiscovery インテグレーション テンプレート を参照してください。追加の構成オプションは、supabase.d/conf.yaml のサンプル を確認してください。

注: Supabase Storage とのインテグレーションは セルフホスト アーキテクチャでのみ利用可能です。storage_api_endpoint には、Prometheus 形式のメトリクスが公開されている場所を設定します。デフォルトのポートは 5000 です。コンテナ環境では、ホスト自動検出 のために %%host%% を使用します。

検証

Agent の status サブコマンドを実行 し、Checks セクションの下に supabase があるか確認します。

収集データ

メトリクス

イベント

Supabase インテグレーションにはイベントは含まれません。

サービスチェック

supabase.openmetrics.health

Returns CRITICAL if the Agent is unable to connect to the Supabase OpenMetrics endpoint, otherwise returns OK.

Statuses: ok, critical

supabase.storage_api.openmetrics.health

Returns CRITICAL if the Agent is unable to connect to the Supabase Storage API OpenMetrics endpoint, otherwise returns OK.

Statuses: ok, critical

トラブルシューティング

ご不明な点は、Datadog のサポートチームまでお問い合わせください。