メインコンテンツまでスキップ
メインコンテンツまでスキップ

Prometheus統合

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

始めるには、APIキーを生成する必要があります。

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

APIリファレンス​

メソッドパス説明
GEThttps://api.clickhouse.cloud/v1/organizations/:organizationId/services/:serviceId/prometheus?filtered_metrics=[true | false]特定のサービスのメトリクスを返します
GEThttps://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サービス名

ClickPipesの場合、メトリクスには次のラベルも含まれます：

ラベル説明
clickpipe_idClickPipe ID
clickpipe_nameClickPipe名
clickpipe_sourceClickPipeソースタイプ

情報メトリクス​

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

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

メトリクスを取得するリクエストは、一時停止されたサービスを再開することはありません。サービスがidle状態の場合、ClickHouse_ServiceInfoメトリクスのみが返されます。

ClickPipesの場合、同様のClickPipes_Infoメトリクスのgaugeがあります。これは、メトリクスラベルに加えて次のラベルを含みます：

ラベル説明
clickpipe_stateパイプの現在の状態

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 Agentの代わりとなるベンダー中立のOpenTelemetry (OTel) Collectorの配布版です。これはスクレイパーとして使用でき、自分のインフラストラクチャにデプロイ可能で、任意の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がカスタムメトリクスと見なす多くのメトリクス・インスタンスの組み合わせがエクスポートされます。