本記事では、Datadogを使用してOceanBase Cloudインスタンスを監視する方法について説明します。
背景
Datadogは、アプリケーション、サービス、サーバー、コンテナなど、エンドツーエンドの技術スタックの稼働状態をリアルタイムで可視化するための包括的なクラウド監視・分析プラットフォームです。2010年のリリース以来、急速に発展し、特にクラウド環境やマイクロサービスアーキテクチャにおいて広く利用されている監視ソリューションとなっています。
OceanBase CloudはDatadogとの連携をサポートしており、データベースクラスタの監視データをDatadogプラットフォームにプッシュすることができます。連携プロセスではOAuthを介してDatadogに接続し、APIキーの入力が不要であるため、連携のセキュリティと利便性が向上しています。Datadogの認可はOceanBase Cloudのユーザーに紐づけられるため、そのユーザーはプロジェクト管理者、インスタンス管理者、またはデータの読み書き権限など、必要なロールを持っている必要があります。複数のプロジェクト内のインスタンスを監視する場合は、そのユーザーに各プロジェクトの対応する権限を付与する必要があります。
説明
現在、専用インスタンスへのデータプッシュのみをサポートしています。
前提条件
紐づけるアカウントはインスタンス権限を持っている必要があり、そのプロジェクトのメンバーは以下のいずれかのロールを持っている必要があります：プロジェクト管理者、インスタンス管理者、またはデータの読み書き権限。プロジェクトメンバーの権限の詳細については、メンバーの管理を参照してください。
Datadog連携の設定
Datadogコンソールにアクセスし、Datadogアカウントでログインします。
OceanBase Cloudコンソールで設定を完了します。
OceanBase Cloudコンソールにアクセスします。
左側のナビゲーションバーで、**統合**をクリックします。
連携ページでDatadogを検索し、**Datadog**をクリックして詳細ページに進みます。
**接続**をクリックします。
認可ページで認可情報を確認し、**承認**をクリックします。
説明
認可ページは初回認可時にのみ表示されます。以降の認可時には、システムは認可成功または失敗のみを通知します。
Datadogコンソールで、Integrationsに移動し、OceanBaseを検索して、OceanBase Cloud Dashboardを追加します。
設定が完了すると、このダッシュボードでOceanBase Cloudインスタンスの監視データを確認できるようになります。
説明
初回設定後、監視データがDatadogにプッシュされるまでに数分かかる場合があります。
Datadog設定の削除
OceanBase Cloudコンソールにアクセスします。
左側のナビゲーションバーで、**統合**をクリックします。
統合ページでDatadogを検索し、**Datadog**をクリックして詳細ページに移動します。
**削除**をクリックします。設定を削除すると、OceanBase CloudはDatadogへの監視データのプッシュを停止します。
DatadogコンソールでOceanBase APIキーを削除します。
説明
削除をクリックした後、Datadog APIキーも削除する必要があります。そうしないと、再度接続をクリックするとエラーが発生します。
Datadogコンソールにログインします。
Organization Settings > API Keysに移動します。
プロフィールの下で対応するAPIキーを削除します。
利用可能な監視メトリクス
メトリクス名 |
説明 |
|---|---|
| all_session | 現在のセッション数 |
| clog_trans_log_total_size | 1秒間にコミットされたトランザクションログサイズ |
| cpu_percent | CPU使用率 |
| load1 | 過去1分間のシステム平均負荷 |
| memory_used | 物理メモリ使用量 |
| net_throughput | ネットワークスループット |
| ob_clog_disk_percent | OceanBaseログディスク使用率 |
| ob_data_disk_percent | データディスク使用率 |
| ob_process_exists | OceanBaseプロセス状態 |
| request_queue_time | SQLリクエストが待機キューで費やす時間 |
| sql_all_count | 1秒間に処理されるSQL文の数 |
| sql_all_rt | SQL文の平均処理時間 |
| transaction_count | 1秒間に処理されるトランザクション数 |
| transaction_rt | サーバートランザクションの平均処理時間 |
| trans_commit_log_count | 1秒間にコミットされるトランザクションログ数 |
よくある質問
Q: 接続 をクリックすると、次のエラーが発生します：Authentication failed, please contact technical support.
A: この問題が発生する原因は、同一組織内に複数のDatadogアカウントが存在し、APIキーを正常に申請できるのは1つのアカウントのみである可能性があります。DatadogでAPIキー情報を確認し、OceanBase APIキーが既に紐づけられているかどうかを確認してください。