Supported OS Linux Windows Mac OS

概要

The CockroachDB Cloud integration for Datadog enables data collection and alerting on a subset of CockroachDB metrics using the Datadog platform.

セットアップ

インストール

Cockroach Cloud クラスターに対して Datadog のモニタリングを有効にするには

  1. On the cluster’s Monitoring > Tools page.

  2. API keyDatadog Site のフィールドに、対応する値を入力します。

    • API key は、Datadog の組織と関連付けられています。Cockroach Cloud クラスターで使用する API キーをお持ちでない場合は、作成する必要があります。手順については、Datadog のドキュメントを参照してください。
    • Datadog Site は、Datadog Site URL に対応します。詳細は、Datadog のドキュメントを参照してください。
  3. Create をクリックします。クラスターのサイズとシステムの現在の負荷によって、インテグレーションが有効になるまでに時間がかかる場合があります。

  4. Datadog に登録されると、Datadog のインフラストラクチャーリストにクラスターが表示されます。これには最大で数分かかることがあります。

構成

Open your Datadog Dashboard List. There are two out of the box dashboards that present CockroachDB metrics

  • CockroachDB Cloud Serverless (Limited Preview)
  • CockroachDB Cloud Dedicated

To create your own Cockroach Cloud dashboard, you can either clone the default CockroachDB Cloud Dedicated dashboard and edit the widgets, or create a new dashboard.

The available metrics are intended for use as building blocks for your own charts.

収集されるメトリクスをプレビューするには、以下の方法があります。

検証

有効化されると、Monitoring ページの Datadog パネルにある Integration status は、Active と表示されるようになります。

インテグレーション中に問題が発生した場合、代わりに以下のステータスのいずれかが表示されることがあります。

  • Active は、インテグレーションが正常にデプロイされたことを示します。
  • Inactive は、インテグレーションが正常にデプロイされていないことを示します。セットアップが行われていないか、エラーが発生したことを示します。
  • Unhealthy は、インテグレーション API キーが無効で、更新する必要があることを示します。
  • Unknown は、不明なエラーが発生したことを示します。このステータスが表示された場合は、サポートチームにお問い合わせください

CockroachDB からのメトリクスエクスポートは、以下のような場合に中断されることがあります。

  • API キーが古くなっている。この場合、インテグレーションのステータスは Unhealthy になります。この問題を解決するには、新しい API キーを使ってインテグレーションを更新してください。
  • CockroachDB が一時的に使用できない。この場合、インテグレーションのステータスは Active のままです。この問題を解決するには、Datadog パネルからインテグレーションを非アクティブ化して再アクティブ化してみてください。それでも問題が解決しない場合は、サポートチームにご連絡ください

To monitor the health of metrics export, you can create a custom Monitor in Datadog.

インテグレーションの更新

インテグレーションに関連するメタデータを更新するには (例えば、API キーをローテーションする)

  1. Datadog パネルで、省略記号をクリックし、Update を選択します。

  2. API keyDatadog Site フィールドを更新し、Create をクリックします。インテグレーションが再デプロイされます。

インテグレーションの非アクティブ化

インテグレーションを非アクティブにするには

  1. Datadog パネルで、省略記号をクリックし、Deactivate integration を選択します。

  2. 無効になると、パネル内の Integration status が、Inactive と表示されます。

インテグレーションを非アクティブにした後も、メトリクスデータは Datadog にデフォルトの保持期間の間残ります。

収集データ

メトリクス

  • crdb_cloud & crdb_dedicated Metrics

サービスチェック

The Cockroach Cloud integration does not include any service checks.

イベント

The Cockroach Cloud integration does not include any events.

サポート

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