メインコンテンツへスキップ
メインコンテンツへスキップ

ClickStack 入門

事前にビルド済みの Docker イメージが提供されているおかげで、ClickStack を簡単に使い始めることができます。これらのイメージは公式の ClickHouse の Debian パッケージに基づいており、さまざまなユースケースに対応できるよう複数のディストリビューションで提供されています。

ローカルデプロイ​

最も簡単なオプションは、スタックのすべてのコアコンポーネントを 1 つにまとめた 単一イメージディストリビューションです。

  • HyperDX UI
  • OpenTelemetry (OTel) collector
  • ClickHouse

このオールインワンイメージを使うと、1 つのコマンドでフルスタックを起動できるため、テストや実験、クイックなローカルデプロイに最適です。

docker でスタックをデプロイする​

以下のコマンドは、OpenTelemetry collector（ポート 4317 と 4318）と HyperDX UI（ポート 8080）を起動します。

docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest
イメージ名の更新

ClickStack のイメージは現在 clickhouse/clickstack-*（以前は docker.hyperdx.io/hyperdx/*）として公開されています。

データと設定の永続化

コンテナの再起動後もデータと設定を保持するには、上記の docker コマンドを変更して、/data/db、/var/lib/clickhouse、/var/log/clickhouse-server のパスをマウントします。

例:

# パスをマウントするようにコマンドを変更 \{#modify-command-to-mount-paths}
docker run \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  -v "$(pwd)/.volumes/db:/data/db" \
  -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
  -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
  clickhouse/clickstack-all-in-one:latest

http://localhost:8080 にアクセスして HyperDX UI を開きます。

ユーザーを作成し、複雑さ要件を満たすユーザー名とパスワードを入力します。

HyperDX UI

HyperDX はローカルクラスターに自動的に接続し、ログ・トレース・メトリクス・セッション用のデータソースを作成します。これにより、すぐに製品を探索できます。

製品を操作してみる​

スタックがデプロイできたら、用意されたデータセットのいずれかを試してみてください。

ローカルクラスターを使い続ける場合:


別の方法として、より大きなデータセットを探索できるデモクラスターに接続することもできます。

ClickHouse Cloud でデプロイする​

ユーザーは ClickHouse Cloud をバックエンドとして ClickStack をデプロイでき、完全にマネージドで安全なバックエンドの利点を享受しつつ、インジェスト、スキーマ、オブザーバビリティのワークフローを完全に制御できます。

ClickHouse Cloud サービスを作成する​

サービスを作成するには、ClickHouse Cloud のクイックスタートガイドに従ってください。

接続情報をコピーする​

HyperDX 用の接続情報を確認するには、ClickHouse Cloud コンソールに移動し、サイドバーの Connect ボタンをクリックします。

HTTP 接続情報、特に HTTPS エンドポイント (endpoint) とパスワードをコピーします。

Connect Cloud
本番環境へのデプロイ

ここでは HyperDX への接続に default ユーザーを使用しますが、本番運用に移行する際には専用のユーザーを作成することを推奨します。

docker でデプロイする​

ターミナルを開き、先ほどコピーした認証情報を環境変数としてエクスポートします:

export CLICKHOUSE_USER=default
export CLICKHOUSE_ENDPOINT=<YOUR HTTPS ENDPOINT>
export CLICKHOUSE_PASSWORD=<YOUR_PASSWORD>

次の docker コマンドを実行します:

docker run -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} -e CLICKHOUSE_USER=default -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest

これにより、OpenTelemetry collector（ポート 4317 および 4318）と HyperDX UI（ポート 8080）が公開されます。

http://localhost:8080 にアクセスして HyperDX UI を開きます。

ユーザー名と、複雑性要件を満たすパスワードを指定してユーザーを作成します。

HyperDX ログイン

ClickHouse Cloud 接続を作成する​

Team Settings に移動し、Local Connection の Edit をクリックします:

接続を編集

接続名を Cloud に変更し、その後のフォームに ClickHouse Cloud サービスの認証情報を入力してから Save をクリックします:

Cloud 接続を作成

プロダクトを触ってみる​

スタックのデプロイが完了したら、用意されているデータセットのいずれかを試してみてください。

ローカルモード​

ローカルモードは、認証なしで HyperDX をデプロイするための方法です。

このモードでは認証はサポートされません。

このモードは、認証や設定の永続化が不要な、迅速なテスト、開発、デモ、およびデバッグといったユースケース向けに想定されています。

ホスト型バージョン​

play.hyperdx.io で利用可能なローカルモードの HyperDX ホスト型バージョンを使用できます。

セルフホスト版​

Docker で実行する​

セルフホストのローカルモードイメージには、OpenTelemetry collector と ClickHouse サーバーがあらかじめ設定された状態で含まれています。これにより、アプリケーションからテレメトリデータを取り込み、最小限の追加設定で HyperDX 上に可視化できます。セルフホスト版を使い始めるには、適切なポートをフォワードして Docker コンテナを実行するだけです:

docker run -p 8080:8080 clickhouse/clickstack-local:latest

ローカルモードには認証機能が含まれていないため、ユーザーの作成を求められることはありません。

接続情報の入力​

独自の 外部 ClickHouse クラスター に接続するには、接続情報を手動で入力できます。

また、製品を手早く試したい場合は、Connect to Demo Server をクリックして、あらかじめロードされたデータセットにアクセスし、セットアップ不要で ClickStack を試すこともできます。

Credentials

デモサーバーに接続した場合は、デモデータセットの手順に従ってデータセットを探索できます。