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

ClickStack 入門

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

ローカルデプロイメント​

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

  • HyperDX UI
  • OpenTelemetry (OTel) collector
  • ClickHouse

このオールインワンイメージを使うと、単一のコマンドでフルスタックを起動できるため、テスト、検証・実験、またはローカル環境での迅速なデプロイに最適です。

Docker を使ってスタックをデプロイ​

次のコマンドでは、OpenTelemetry (OTel) collector（ポート 4317 および 4318）と HyperDX UI（ポート 8080）を起動します。

docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one
データと設定の永続化

コンテナの再起動をまたいでデータと設定を永続化するには、上記の 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" \
  docker.hyperdx.io/hyperdx/hyperdx-all-in-one

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

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

HyperDX UI

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

製品を探索する​

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

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

  • Example dataset - 公開デモからサンプルデータセットを読み込み、シンプルな問題を診断します。
  • Local files and metrics - ローカルの OTel collector を使用して、OSX または Linux 上のローカルファイルを読み込み、システムを監視します。

あるいは、より大きなデータセットを探索できるデモクラスタに接続することもできます。

  • Remote demo dataset - デモ用 ClickHouse サービス内のデモデータセットを探索します。

ClickHouse Cloud でデプロイする​

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

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 docker.hyperdx.io/hyperdx/hyperdx-all-in-one

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

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

ユーザーを作成し、パスワードポリシーの要件を満たすユーザー名とパスワードを入力します。

HyperDX Login

ClickHouse Cloud 接続を作成する​

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

Edit Connection

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

Create Cloud connection

プロダクトを試す​

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

ローカルモード​

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

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

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

ホスト型バージョン​

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

セルフホスト版​

Docker で実行する​

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

docker run -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx-local

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

接続クレデンシャルの入力​

自身の 外部 ClickHouse クラスター に接続するには、接続クレデンシャルを手動で入力します。

また、製品をすばやく試したい場合は、デモサーバーに接続 をクリックして、あらかじめ読み込まれたデータセットにアクセスし、セットアップ不要で ClickStack を試すこともできます。

クレデンシャル

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