BYOCデプロイメントには包括的なオブザーバビリティ機能が備わっており、専用のPrometheus監視スタックや ClickHouseサーバーが直接公開するメトリクスエンドポイントを通じて、ClickHouseサービスを監視できます。すべてのオブザーバビリティデータはお使いのクラウドアカウント内に保持されるため、監視インフラストラクチャを完全に制御できます。
BYOC では、Prometheus を使用してメトリクスを収集・可視化する主な方法が 2 つあります。
- 組み込みの Prometheus スタックに接続する: BYOC Kubernetes クラスター内で稼働している、あらかじめインストールされた一元管理の Prometheus インスタンスにアクセスします。
- ClickHouse のメトリクスを直接スクレイプする: 各 ClickHouse サービスが公開する
/metrics_all エンドポイントに、独自の Prometheus デプロイメントを向けます。
| Capability | 組み込みのPrometheusスタック | ClickHouseサービスからの直接スクレイピング |
|---|
| Metrics Scope | ClickHouse、Kubernetes、補助サービスのメトリクスを集約 (クラスター全体を可視化) | 個々のClickHouseサーバーのメトリクスのみ |
| Setup Process | プライベートネットワークアクセスの設定が必要 (例: プライベートロードバランサー 経由) | PrometheusでパブリックまたはプライベートのClickHouseエンドポイントをスクレイプするよう設定するだけ |
| How You Connect | VPC/ネットワーク内のプライベートロードバランサー経由で接続 | データベースアクセスに使用するものと同じエンドポイント |
| Authentication | 不要 (プライベートネットワーク内に限定) | ClickHouseサービスの認証情報を使用 |
| Network Prerequisites | プライベートロードバランサーと適切なネットワーク接続が必要 | ClickHouseエンドポイントにアクセスできる任意のネットワークで利用可能 |
| Best Suited For | インフラストラクチャとサービスの包括的な監視 | サービス単位の監視とインテグレーション |
| How to Integrate | 外部Prometheusでフェデレーションを設定し、クラスターのメトリクスを取り込む | ClickHouseのメトリクス用エンドポイントをPrometheusのconfigに直接追加 |
組み込み BYOC Prometheus スタック
- ClickHouse サーバー と ClickHouse Keeper
- Kubernetes クラスターおよびシステムコンポーネント
- 基盤インフラストラクチャのノード
組み込みの Prometheus スタックに接続するには、次の手順に従います。
- BYOC 環境でプライベートロードバランサーを有効にするため、ClickHouse Support に連絡します。
- Prometheus エンドポイント URL を ClickHouse Support に依頼します。
- Prometheus エンドポイントへのプライベートネットワーク接続を確認します。通常は、VPC peering またはその他のプライベートネットワーク構成を使用します。
エンドポイントのフォーマットは、接続タイプによって異なります。
| 接続方式 | エンドポイントのフォーマット |
|---|
| VPC / VPC peering | https://prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com |
| PrivateLink | https://prometheus.vpce.<subdomain>.<region>.<cloud>.clickhouse-byoc.com |
Prometheus スタックの URL にはプライベートネットワーク接続経由でのみアクセスでき、認証は不要です。アクセスできるのは、VPC peering またはその他のプライベート接続オプションを介して BYOC VPC に到達可能なネットワークに限られます。
- お好みの監視プラットフォームやカスタムダッシュボードから、Prometheus の API エンドポイントに直接アクセスします。
- PromQL クエリを使用して、必要なメトリクスを抽出、集計、可視化します。
- 独自のダッシュボードやアラート パイプラインの構築に適しています。
Prometheus のクエリエンドポイント /query:
https://prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com/query
- 外部の Prometheus インスタンスを設定し、ClickHouse BYOC の Prometheus スタックからメトリクスをフェデレーション (pull) するようにします。
- これにより、複数の環境やクラスターのメトリクス収集を統合し、一元化できます。
- Prometheus フェデレーション設定の例:
scrape_configs:
- job_name: 'federate-clickhouse-byoc'
scrape_interval: 15s
honor_labels: true
metrics_path: '/federate'
params:
'match[]':
- '{job="clickhouse"}'
- '{job="kubernetes"}'
static_configs:
- targets:
- 'prometheus-internal.<subdomain>.<region>.<cloud>.clickhouse-byoc.com'
ClickHouse service の Prometheus インテグレーション
/metrics_allで利用できます。
curl --user <username>:<password> https://<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443/metrics_all
# HELP ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes system databaseの`s3disk`ディスクに保存されているバイト数
# TYPE ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes gauge
ClickHouse_CustomMetric_StorageSystemTablesS3DiskBytes{hostname="c-jet-ax-16-server-43d5baj-0"} 62660929
# HELP ClickHouse_CustomMetric_NumberOfBrokenDetachedParts 破損したデタッチされたパーツの数
# TYPE ClickHouse_CustomMetric_NumberOfBrokenDetachedParts gauge
ClickHouse_CustomMetric_NumberOfBrokenDetachedParts{hostname="c-jet-ax-16-server-43d5baj-0"} 0
# HELP ClickHouse_CustomMetric_TotalNumberOfErrors 最後の再起動以降にサーバーで発生したエラーの総数
# TYPE ClickHouse_CustomMetric_TotalNumberOfErrors gauge
ClickHouse_CustomMetric_TotalNumberOfErrors{hostname="c-jet-ax-16-server-43d5baj-0"} 9
default ユーザーを使用するか、メトリクスのスクレイピング専用に必要最小限の権限を持つ専用ユーザーを作成することを推奨します。
必要な権限:
- サービスへの接続に必要な
REMOTE 権限
- 関連するシステムテーブルに対する
SELECT 権限
ユーザー設定例:
CREATE USER scrapping_user IDENTIFIED BY 'secure_password';
GRANT REMOTE ON *.* TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_custom_metrics_tables TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_database_replicated_recovery_time TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_failed_mutations TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_group TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_shared_catalog_recovery_time TO scrapping_user;
GRANT SELECT ON system._custom_metrics_dictionary_table_read_only_duration_seconds TO scrapping_user;
GRANT SELECT ON system._custom_metrics_view_error_metrics TO scrapping_user;
GRANT SELECT ON system._custom_metrics_view_histograms TO scrapping_user;
GRANT SELECT ON system._custom_metrics_view_metrics_and_events TO scrapping_user;
GRANT SELECT(description, metric, value) ON system.asynchronous_metrics TO scrapping_user;
GRANT SELECT ON system.custom_metrics TO scrapping_user;
GRANT SELECT(name, value) ON system.errors TO scrapping_user;
GRANT SELECT(description, event, value) ON system.events TO scrapping_user;
GRANT SELECT(description, labels, metric, value) ON system.histogram_metrics TO scrapping_user;
GRANT SELECT(description, metric, value) ON system.metrics TO scrapping_user;
global:
scrape_interval: 15s
scrape_configs:
- job_name: "clickhouse"
static_configs:
- targets: ["<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443"]
scheme: https
metrics_path: "/metrics_all"
basic_auth:
username: <username>
password: <password>
honor_labels: true
<service-subdomain>.<byoc-subdomain>.<region>.<provider>.byoc.clickhouse-byoc.com:8443 を実際のサービスエンドポイントに<username> と <password> をスクレイピングユーザーの認証情報に
すぐに使えるダッシュボード群を必要とするチーム向けに、ClickHouse は Prometheus ClickHouse Mixin を提供しています。これは、ClickHouse クラスターの監視用に特別に設計された、あらかじめ用意された Grafana ダッシュボードです。
Grafana のセットアップと ClickHouse Mix-in のインポート
- Grafana で Prometheus をデータソースとして追加する
Grafana のサイドバーで「Data sources」に移動し、「Add data source」をクリックして「Prometheus」を選択します。接続するには、Prometheus インスタンスの URL と必要な認証情報を入力します。
- ClickHouse ダッシュボードをインポートする
Grafana でダッシュボード画面に移動し、「Import」を選択します。ダッシュボードの JSON ファイルをアップロードするか、その内容を直接貼り付けます。JSON ファイルは ClickHouse Mix-in のリポジトリから取得できます。
ClickHouse Mix-in Dashboard JSON
- メトリクスを確認する
ダッシュボードをインポートし、Prometheus のデータソースを設定すると、ClickHouse Cloud サービスのリアルタイム メトリクスが表示されます。
