ClickHouse に組み込み

ClickHouse Server に組み込まれた ClickStack を使用する - ClickHouse オブザーバビリティスタック

ClickStack は ClickHouse server バイナリに直接組み込まれています。つまり、追加のコンポーネントをデプロイしなくても、ClickHouse インスタンスから ClickStack UI (HyperDX) にアクセスできます。このデプロイは play-clickstack.clickhouse.com の公開デモに似ていますが、お使いの ClickHouse インスタンスとデータを対象に動作します。

​

適した用途

• 最小限のセットアップでClickStackを試したい場合
• オブザーバビリティUIで自分のClickHouseデータを確認したい場合
• デモや評価

​

制限事項

この組み込み版は、本番環境での利用向けには設計されていません。本番対応の OSS デプロイメントと比べると、以下の機能は利用できません。

• アラート
• ダッシュボードと検索の永続化 — ダッシュボードと保存済み検索はセッションをまたいで保持されません
• クエリ設定のカスタマイズ
• イベントパターン

​

デプロイ手順

Docker

1. ​

   ClickHouse を起動する

   パスワードを設定して、ClickHouse server イメージを取得し、起動します。

   docker run --rm -it -p 8123:8123 -e CLICKHOUSE_PASSWORD=password clickhouse/clickhouse-server:head-alpine
   

   パスワードなしで実行する

   パスワードなしで実行する場合は、デフォルトのアクセス管理を明示的に有効化する必要があります。

   docker run --rm -it -p 8123:8123 -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 clickhouse/clickhouse-server:head-alpine
   
2. ​

   ClickStack UI を開く

   ブラウザで http://localhost:8123 を開き、ClickStack をクリックします。

   ユーザー名 default とパスワード password を入力して、ローカルインスタンスに接続します。

3. ​

   ログソースを作成する

   既存の OpenTelemetry テーブルがある場合、ClickStack がそれらを検出し、自動的にログソースを作成します。

   新規インストールの場合は、ログソースの作成を求められます。Table フィールドに適切なテーブル名 (例: otel_logs) を入力し、Save New Source をクリックします。

   まだデータがない場合は、利用可能なオプションについて Ingesting data を参照してください。

バイナリ

1. ​

   ClickHouse を起動する

   ClickHouse をダウンロードして起動します。

   curl https://clickhouse.com/ | sh
   

   任意: システムログテーブルを有効にする

   ClickHouse 自身の内部ログとメトリクスを確認するには、サーバーを起動する前に作業ディレクトリに設定スニペットを作成します。

   mkdir -p config.d && cat > config.d/query_logs.xml << 'EOF'
   <clickhouse>
       <query_log>
           <database>system</database>
           <table>query_log</table>
       </query_log>
       <query_thread_log>
           <database>system</database>
           <table>query_thread_log</table>
       </query_thread_log>
       <query_views_log>
           <database>system</database>
           <table>query_views_log</table>
       </query_views_log>
       <metric_log>
           <database>system</database>
           <table>metric_log</table>
       </metric_log>
       <asynchronous_metric_log>
           <database>system</database>
           <table>asynchronous_metric_log</table>
       </asynchronous_metric_log>
   </clickhouse>
   EOF
   

   これを有効にすると、ClickStack を開いたあとで system.query_log を指す Log Source を作成できます。

   設定	値
   Name	Query Logs
   Database	system
   Table	query_log
   Timestamp Column	event_time
   Default Select	event_time, query_kind, query, databases, tables, initial_user, projections, memory_usage, written_rows, read_rows, query_duration_ms

   サーバーを起動します。

   ./clickhouse server
   
2. ​

   ClickStack UI を開く

   ブラウザで http://localhost:8123 を開き、ClickStack をクリックします。ローカルインスタンスへの接続は自動的に作成されます。

3. ​

   ログソースを作成する

   既存の OpenTelemetry テーブルがある場合、ClickStack がそれらを検出し、自動的にログソースを作成します。

   まだデータがない場合は、利用可能なオプションについて Ingesting data を参照してください。

​

次のステップ

評価段階を終えて次に進む準備ができている場合は、本番運用に対応したデプロイを検討してください。

• All-in-One — 永続化と認証を含む、すべてのコンポーネントを備えた単一コンテナー
• Docker Compose — より細かく制御するための個別コンポーネント構成
• Helm — 本番 Kubernetes デプロイに推奨
• Managed ClickStack — ClickHouse Cloud 上で提供される完全マネージド型