HyperDX のみ | ClickHouse Docs

このオプションは、オブザーバビリティデータやイベントデータがすでに格納されている稼働中の ClickHouse インスタンスがある場合を想定したものです。

HyperDX はスタックの他の部分とは独立して使用でき、OpenTelemetry (OTel) だけでなく、任意のデータスキーマに対応しています。そのため、すでに ClickHouse 上に構築されているカスタムのオブザーバビリティパイプラインに適しています。

すべての機能を利用するには、ダッシュボード、保存済み検索、ユーザー設定、アラートなどのアプリケーション状態を保存するための MongoDB インスタンスを用意する必要があります。

このモードでは、データインジェストは完全にユーザー側で行います。独自にホストした OpenTelemetry collector、クライアントライブラリからの直接インジェスト、ClickHouse ネイティブのテーブルエンジン (Kafka や S3 など) 、ETL パイプライン、または ClickPipes のようなマネージドインジェストサービスを使用して、ClickHouse にデータを取り込むことができます。このアプローチは最大限の柔軟性を提供し、すでに ClickHouse を運用していて、その上に HyperDX を重ねて可視化、検索、アラート機能を追加したいチームに適しています。

適したケース

既存のClickHouseユーザー
カスタムのイベントパイプライン

デプロイ手順

Docker でデプロイ

必要に応じて YOUR_MONGODB_URI を変更して、次のコマンドを実行します。

docker run -e MONGO_URI=mongodb://YOUR_MONGODB_URI -p 8080:8080 docker.hyperdx.io/hyperdx/hyperdx

HyperDX UI を開く

HyperDX UI にアクセスするには、http://localhost:8080 を開きます。

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

Create をクリックすると、接続情報の入力を求められます。

接続情報を入力

使用する外部 ClickHouse クラスター (例: ClickHouse Cloud) に接続します。

ログソースの作成を求められた場合は、すべてのデフォルト値をそのまま使用し、Table フィールドに otel_logs を入力します。その他の設定は自動検出されるため、Save New Source をクリックできます。

Docker Compose を使用する

Docker Compose 設定を変更することで、このガイドと同じ構成にできます。その際は、マニフェストから OTel collector と ClickHouse インスタンスを削除してください。

ClickStack OpenTelemetry collector

スタック内の他のコンポーネントとは独立して独自の OpenTelemetry collector を運用している場合でも、collector には ClickStack 版を使用することを推奨します。これにより、デフォルトのスキーマが使用され、インジェストに関するベストプラクティスが適用されます。

スタンドアロンの collector のデプロイと設定の詳細については、「OpenTelemetry を使用した取り込み」を参照してください。

スキーマの選択: Map と JSON

ClickStack は、デフォルトで属性を Map(LowCardinality(String), String) カラムとして保存します。これは、オブザーバビリティのワークロードに推奨されるスキーマです。bucketed map serialization と、Map のキーおよび値に対するテキスト索引を組み合わせることで、動的な JSON サブカラムのようにキーごとの取り込みオーバーヘッドを発生させることなく、必要なルックアップだけを効率的に実行できます。

JSON 型のスキーマは、属性キーの集合が小さく安定しているワークロードで評価するためのベータ機能として利用できます。これはデフォルトとしては推奨されません。詳しい比較と、JSON サポートを有効にするために必要な環境変数については、Map と JSON 型の比較を参照してください。