APIリファレンス
組織全体のメトリクスエンドポイント (
GET /v1/organizations/{organizationId}/prometheus) は、サービスの自動検出の導入に伴い非推奨となりました。既存の組織では引き続き使用できますが、新しく作成された組織では代わりにディスカバリーエンドポイントが使用されます。このエンドポイントへのアクセスが必要な場合は、ClickHouse Supportにお問い合わせください。
これらのエンドポイントの完全なリクエストおよびレスポンススキーマは、Cloud API リファレンスで確認できます。
基本認証には、ClickHouse Cloud API キーを使用します。
ClickPipes のメトリクスには、以下のラベルも含まれます。
ClickHouse Cloud は、値が常に
1 の特別な Gauge メトリクス ClickHouse_ServiceInfo を提供します。このメトリクスには、すべての Metric Labels に加えて、次のラベルが含まれます。
メトリクス取得のリクエストでは、idled 状態のサービスは再開されません。サービスが
idle 状態の場合、ClickHouse_ServiceInfo メトリクスのみが返されます。
ClickPipes にも同様に Gauge メトリクス ClickPipes_Info があり、Metric Labels に加えて次のラベルが含まれます。
Prometheus の設定
Prometheus サーバーは、設定されたターゲットから指定した間隔でメトリクスを収集します。以下は、Prometheus サーバーで ClickHouse Cloud の Prometheus エンドポイントを使用するための設定例です。honor_labels の設定パラメーターは、インスタンスラベルが正しく設定されるよう true に設定する必要がある点に注意してください。さらに、上記の例では filtered_metrics も true に設定されていますが、これはユーザーの好みに応じて設定してください。組織内のすべてのサービスをスクレイプするには、自動サービス検出を使用してください。
自動サービス検出
ディスカバリーエンドポイントは、組織内のサービスごとに1つのスクレイプターゲットを、Prometheus の HTTP service discovery (http_sd) フォーマットで返します。Prometheus はディスカバリーのポーリングごとにターゲットリストを更新し、検出された各ターゲットをスクレイプするため、新たに作成されたサービスは自動的に追加され、削除されたサービスはターゲットリストから除外されます。API キーに閲覧権限のあるサービスのみが含まれ、削除中または削除済みのサービスは含まれません。
使用するには、http_sd_configs job でディスカバリーエンドポイントを指定します。
basic_auth を設定します。http_sd_configs 配下のブロックではディスカバリーのポーリングを認証し、スクレイプジョブのブロックではサービスごとのメトリクススクレイプを認証します。静的設定と同様に、インスタンスラベルが適切に設定されるよう honor_labels: true を設定します。
ディスカバリー応答のサンプル:
__meta_clickhouse_region、__meta_clickhouse_provider、__meta_clickhouse_tag_<key> ラベルとして付与されます。__meta_clickhouse_tagpresent_<key> は、値を持たないタグも含め、すべてのタグで true になります。タグキーに含まれる英字、数字、アンダースコア以外の文字は _ に置き換えられます。Prometheus はリラベル後に __meta_ ラベルを削除するため、ターゲットをフィルタしたり、これらのラベルを保持したりするには relabel_configs を使用します。
filtered_metrics=true を指定してスクレイプされます。すべてのメトリクスセットをスクレイプするターゲットを検出するには、検出 URL に ?filtered_metrics=false を追加します。エンドポイントの完全な仕様については、Cloud API リファレンスを参照してください。
Grafana と統合する主な方法は 2 つあります。
- Metrics Endpoint – この方法の利点は、追加のコンポーネントやインフラストラクチャが不要なことです。この機能は Grafana Cloud でのみ利用でき、必要なのは ClickHouse Cloud Prometheus エンドポイント URL と認証情報だけです。
- Grafana Alloy - Grafana Alloy は、Grafana Agent に代わる、ベンダー中立の OpenTelemetry (OTel) collector ディストリビューションです。スクレーパーとして使用でき、自社のインフラストラクチャにデプロイ可能で、あらゆる Prometheus エンドポイントと互換性があります。
Metrics Endpoint を使用した Grafana Cloud
- Grafana Cloud アカウントにログインします
- Metrics Endpoint を選択して、新しい接続を追加します
- Scrape URL が Prometheus エンドポイントを指すように設定し、ベーシック認証を使用して API キー/シークレットで接続を構成します
- 接続テストを実行し、接続できることを確認します

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


Grafana Cloud で Alloy を使用する
Grafana Cloud を使用している場合は、Grafana の Alloy メニューに移動し、画面上の指示に従って Alloy をインストールできます。
これにより、認証トークンを使用して Grafana Cloud のエンドポイントにデータを送信するための
prometheus.remote_write コンポーネントを含むように Alloy が設定されます。あとは、Alloy の設定 (Linux では /etc/alloy/config.alloy) を変更し、ClickHouse Cloud Prometheus エンドポイント用のスクレーパーを追加するだけです。
以下は、ClickHouse Cloud エンドポイントからメトリクスをスクレイプするための prometheus.scrape コンポーネントと、自動的に設定される prometheus.remote_write コンポーネントを含む Alloy の設定例です。basic_auth 設定コンポーネントには、それぞれユーザー名とパスワードとして Cloud API キーの ID とシークレットが含まれている点に注意してください。
honor_labels 設定パラメーターを true に設定する必要がある点に注意してください。
Alloy を使用する Grafana のセルフマネージド環境
Grafana をセルフマネージドで利用している場合、Alloy エージェントのインストール手順はこちらで確認できます。ここでは、Alloy が Prometheus メトリクスを任意の宛先に送信するよう設定済みであることを前提としています。以下のprometheus.scrape コンポーネントにより、Alloy は ClickHouse Cloud エンドポイント をスクレイプします。スクレイプしたメトリクスは prometheus.remote_write が受け取る想定です。これが存在しない場合は、forward_to key を対象の宛先に合わせて調整してください。

インスタンスラベルが正しく設定されるようにするには、
honor_labels 設定パラメーターを true に設定する必要がある点に注意してください。
Datadog とのインテグレーション
Datadog の Agent と OpenMetrics インテグレーション を使用すると、ClickHouse Cloud エンドポイントからメトリクスを収集できます。以下に、この Agent とインテグレーションのシンプルな設定例を示します。ただし、実際には本当に必要なメトリクスだけを選択することをおすすめします。以下の包括的な例では、数千にも及ぶメトリクスとインスタンスの組み合わせがエクスポートされ、Datadog ではそれらがカスタムメトリクスとして扱われますので注意してください。
関連ページ
- 監視の概要 — ClickHouse Cloud のすべての監視方法を比較
- Cloud Console の監視 — 外部ツール不要の組み込みダッシュボード
- コミュニティおよびパートナーのインテグレーション — Datadog agent のインテグレーションとコミュニティ提供のソリューション
- システムテーブルのクエリ — システムメトリクスに SQL で直接アクセス
- ClickHouse Managed Postgres Prometheus エンドポイント — ClickHouse Managed Postgres サービスのメトリクスをスクレイプ