hyperdxio/hyperdx:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく hyperdxio/hyperdx の導入と確認ガイドです。
プロジェクトの範囲
hyperdxio/hyperdx の README はプロジェクトを「Resolve production issues, fast. An open source observability platform unifying session replays, logs, metrics, traces and errors powered by ClickHouse and OpenTelemetry.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Spinning Up HyperDX」には次の説明があります。HyperDX can be deployed as part of ClickStack, which includes ClickHouse, HyperDX, OpenTelemetry Collector and MongoDB.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「README」にある内容から、用途が合うかを先に判断できます。📝 Schema agnostic, works on top of your existing ClickHouse schema。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。🕵️ Correlate/search logs, metrics, session replays and traces all in one place。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Spinning Up HyperDX」など複数の箇所に分かれています。確認できる情報は次の通りです。If you already have an existing ClickHouse instance, want to use a single container locally, or are looking for production deployment instructions, you can view the different deployment options in our deployment docs.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one 実行可能なコマンドがない場合は手順を作らず、「Hosted ClickHouse Cloud」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Spinning Up HyperDX」には> If your server is behind a firewall, you'll need to open/forward port 8080, > 8000 and 4318 on your firewall for the UI, API and OTel collector > respectively.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料には🔥 Blazing fast searches & visualizations optimized for ClickHouseともあります。