Prometheus統合

この機能は、Prometheusと統合してClickHouse Cloudサービスを監視することをサポートします。Prometheusメトリクスへのアクセスは、ユーザーが安全に接続し、メトリクスをPrometheusメトリクスコレクターにエクスポートできるClickHouse Cloud APIエンドポイントを介して公開されます。これらのメトリクスは、GrafanaやDatadogなどのダッシュボードと統合して視覚化することができます。

始めるには、APIキーを生成します。

ClickHouse Cloudメトリクスを取得するためのPrometheusエンドポイントAPI

APIリファレンス

メソッド	パス	説明
GET	https://api.clickhouse.cloud/v1/organizations/:organizationId/services/:serviceId/prometheus?filtered_metrics=[true | false]	特定のサービスのメトリクスを返します
GET	https://api.clickhouse.cloud/v1/organizations/:organizationId/prometheus?filtered_metrics=[true | false]	組織内のすべてのサービスのメトリクスを返します

リクエストパラメータ

名前	ロケーション	型
Organization ID	エンドポイントアドレス	uuid
Service ID	エンドポイントアドレス	uuid (オプション)
filtered_metrics	クエリパラメータ	boolean (オプション)

認証

基本認証には、ClickHouse Cloud APIキーを使用します:

サンプルレスポンス

メトリクスラベル

すべてのメトリクスには、次のラベルがあります:

ラベル	説明
clickhouse_org	組織ID
clickhouse_service	サービスID
clickhouse_service_name	サービス名

情報メトリクス

ClickHouse Cloudは、ClickHouse_ServiceInfoという特別なメトリクスを提供します。これは常に値が1であるgaugeです。このメトリクスには、すべてのメトリクスラベルに加えて、次のラベルも含まれています:

ラベル	説明
clickhouse_cluster_status	サービスの状態。次のいずれかの値です: [awaking | running | degraded | idle | stopped]
clickhouse_version	サービスが実行されているClickHouseサーバーのバージョン
scrape	最後のスクレイプの状態を示します。fullまたはpartialのいずれかです
full	最後のメトリクススクレイプ中にエラーがなかったことを示します
partial	最後のメトリクススクレイプ中にいくつかのエラーがあり、ClickHouse_ServiceInfoメトリクスのみが返されたことを示します

メトリクスを取得するためのリクエストは、アイドル状態のサービスを再開しません。サービスがidle状態の場合、ClickHouse_ServiceInfoメトリクスのみが返されます。

Prometheusの設定

Prometheusサーバーは、設定されたターゲットからメトリクスを指定された間隔で収集します。以下は、ClickHouse Cloud Prometheusエンドポイントを使用するためのPrometheusサーバーの設定例です:

honor_labels設定パラメータは、インスタンスラベルを正しく設定するためにtrueに設定する必要があります。さらに、上記の例ではfiltered_metricsがtrueに設定されていますが、ユーザーの好みに基づいて設定する必要があります。

Grafanaとの統合

ユーザーはGrafanaと統合するための2つの主要な方法があります:

• メトリクスエンドポイント – このアプローチは、追加のコンポーネントやインフラが不要な利点があります。この提供はGrafana Cloudに限定されており、ClickHouse Cloud PrometheusエンドポイントのURLと資格情報のみが必要です。
• Grafana Alloy - Grafana Alloyは、Grafanaエージェントに代わるベンダーニュートラルなOpenTelemetry (OTel) コレクターの配布です。これはスクレイパーとして使用でき、自分のインフラストラクチャにデプロイ可能で、すべてのPrometheusエンドポイントと互換性があります。

以下に、ClickHouse Cloud Prometheusエンドポイントに特化した詳細に焦点を当てて、これらのオプションを使用するための手順を提供します。

メトリクスエンドポイントを使用したGrafana Cloud

• Grafana Cloudアカウントにログインします。
• メトリクスエンドポイントを選択して新しい接続を追加します。
• スクレイプURLをPrometheusエンドポイントにポイントし、APIキー/シークレットで接続を構成するために基本認証を使用します。
• 接続できることを確認するために接続をテストします。

設定が完了すると、ダッシュボードを構成するために選択できるメトリクスがドロップダウンに表示されるはずです:

Alloyを使用したGrafana Cloud

Grafana Cloudを使用している場合、GrafanaのAlloyメニューに移動し、画面の指示に従ってAlloyをインストールできます:

これにより、データをGrafana Cloudエンドポイントに送信するためのprometheus.remote_writeコンポーネントを使用してAlloyが構成されます。ユーザーは次に、ClickHouse Cloud Prometheusエンドポイント用のスクレイパーを含めるためにAlloyの設定（Linuxでは/etc/alloy/config.alloyにあります）を変更する必要があります。

以下は、ClickHouse Cloudエンドポイントからメトリクスをスクレイプするためのprometheus.scrapeコンポーネントを持つAlloyの設定例と、自動的に構成されたprometheus.remote_writeコンポーネントを示しています。basic_auth設定コンポーネントには、Cloud APIキーIDとシークレットがそれぞれユーザー名とパスワードとして含まれています。

honor_labels設定パラメータは、インスタンスラベルを正しく設定するためにtrueに設定する必要があります。

Alloyを使用したセルフマネージドGrafana

セルフマネージドのGrafanaユーザーは、Alloyエージェントのインストールに関する指示をこちらで見つけることができます。ユーザーは、Alloyを設定してPrometheusメトリクスを希望の宛先に送信するように設定されたと仮定します。以下のprometheus.scrapeコンポーネントは、AlloyがClickHouse Cloudエンドポイントをスクレイプする原因となります。prometheus.remote_writeはスクレイプされたメトリクスを受け取ると仮定します。この宛先が存在しない場合は、forward_toキーを希望の受信先に調整してください。

設定が完了すると、メトリクスエクスプローラーにClickHouse関連のメトリクスが表示されるようになります:

honor_labels設定パラメータは、インスタンスラベルを正しく設定するためにtrueに設定する必要があります。

Datadogとの統合

DatadogのエージェントおよびOpenMetrics統合を使用して、ClickHouse Cloudエンドポイントからメトリクスを収集できます。以下に、このエージェントと統合のシンプルな設定例を示します。ただし、最も関心のあるメトリクスのみを選択することをお勧めします。以下の汎用例では、Datadogがカスタムメトリクスとして扱う数千のメトリクスインスタンスの組み合わせがエクスポートされます。