ClickHouse への組み込み

ClickStack は ClickHouse サーバーのバイナリに直接バンドルされています。つまり、追加のコンポーネントをデプロイすることなく、ClickHouse インスタンスから ClickStack UI (HyperDX) にアクセスできます。このデプロイメントは play-clickstack.clickhouse.com で公開されているデモと似ていますが、実際には自身の ClickHouse インスタンスとデータに対して実行されます。

適している用途

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

制限事項

この埋め込み版は本番環境での利用を目的として設計されていません。本番運用向けの OSS デプロイメントと比較して、以下の機能は利用できません。

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

デプロイ手順

Docker

ClickHouse を起動する

パスワードを設定して ClickHouse サーバーイメージを取得して起動します:

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

ClickStack UI を開く

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

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

ソースを作成する

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

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

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

Binary

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

ClickStack UI を開く

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

ソースを作成する

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

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

次のステップ

評価を終えて本番運用に進む準備ができたら、次の本番向けデプロイメントを検討してください：

• All-in-One — 永続化と認証を含む、すべてのコンポーネントを 1 つのコンテナにまとめた構成
• Docker Compose — より細かい制御が可能な個別コンポーネント構成
• Helm — 本番環境の Kubernetes デプロイメントに推奨
• Managed ClickStack — ClickHouse Cloud 上でのフルマネージド構成