メインコンテンツまでスキップ
メインコンテンツまでスキップ

HyperDX のみ

このオプションは、すでに稼働中の ClickHouse インスタンスに可観測性またはイベントデータが格納されているユーザーを対象としています。

HyperDX は、スタックの他の部分とは独立して使用でき、任意のデータスキーマと互換性があります - OpenTelemetry (OTel) のみではありません。これにより、既に ClickHouse 上に構築されたカスタム可観測性パイプラインに適しています。

完全な機能を利用するには、ダッシュボード、保存された検索、ユーザー設定、およびアラートを含むアプリケーションの状態を保存するための MongoDB インスタンスを提供する必要があります。

このモードでは、データの取り込みは完全にユーザーに委ねられます。ホスティングされた OpenTelemetry コレクター、自身のクライアントライブラリからの直接的な取り込み、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

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

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

Create をクリックすると、接続の詳細を求められます。

HyperDX UI

接続の詳細を完了する

自身の外部 ClickHouse クラスターに接続します(例: ClickHouse Cloud)。

HyperDX Login

ソースを作成するように求められた場合は、すべてのデフォルト値を保持し、Table フィールドを otel_logs の値で完了させます。その他の設定は自動検出されるので、Save New Source をクリックできます。

ソース作成

ソースを作成するには、ClickHouse にテーブルが存在する必要があります。データがない場合は、ClickStack OpenTelemetry コレクターをデプロイしてテーブルを作成することをお勧めします。

Docker Compose の使用

ユーザーは、Docker Compose 設定 を修正して、このガイドと同じ効果を得ることができます。マニフェストから OTel コレクターと ClickHouse インスタンスを削除します。

ClickStack OpenTelemetry コレクター

他のスタックコンポーネントとは独立して OpenTelemetry コレクターを管理している場合でも、ClickStack 配布版のコレクターを使用することをお勧めします。これにより、デフォルトのスキーマが使用され、取り込みのベストプラクティスが適用されます。

スタンドアロンコレクターのデプロイと設定に関する詳細は、"Ingesting with OpenTelemetry"を参照してください。

JSONタイプサポート

Beta feature. Learn more.

ClickStackはバージョン 2.0.4 から JSONタイプ に対するベータサポートを提供しています。

このタイプの利点については、JSONタイプの利点を参照してください。

JSONタイプのサポートを有効にするためには、ユーザーは以下の環境変数を設定する必要があります:

  • OTEL_AGENT_FEATURE_GATE_ARG='--feature-gates=clickhouse.json' - OTelコレクターでのサポートを有効にし、JSONタイプを使用してスキーマが作成されることを保証します。
  • BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true - HyperDXアプリケーションでのサポートを有効にし、JSONデータをクエリできるようにします。

HyperDX 専用のイメージでは、ユーザーは BETA_CH_OTEL_JSON_SCHEMA_ENABLED=true パラメータを設定するだけで済みます。例えば、

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