本番運用に向けて

ClickStack の本番運用に向けて

本番環境で ClickStack をデプロイする際は、セキュリティ、安定性、適切な構成を確保するために、いくつか追加で考慮すべき点があります。これらは、使用するディストリビューション (オープンソース版またはマネージド版) によって異なります。

Managed ClickStack

本番環境へのデプロイには、Managed ClickStack を推奨します。デフォルトで、強化された暗号化、認証と接続、マネージドなアクセス制御を含む業界標準のセキュリティ対策が適用されるほか、次の利点があります。

• ストレージとは独立したコンピュートの自動スケーリング
• オブジェクトストレージを基盤とした、低コストで実質的に無制限のデータ保持
• Warehouses により、読み取りワークロードと書き込みワークロードを個別に分離可能
• 統合認証
• 自動化されたバックアップ
• シームレスなアップグレード

Managed ClickStack を使用する場合は、ClickHouse Cloud 向けのベストプラクティスに従ってください。

​

インジェストの保護

デフォルトでは、Open Source ディストリビューション以外でデプロイされた ClickStack OpenTelemetry Collector は保護されておらず、OTLP ポートでの認証も不要です。

インジェストを保護するには、OTLP_AUTH_TOKEN 環境変数を使用して collector をデプロイする際に認証トークンを指定します。詳しくは、“collector の保護”を参照してください。

​

インジェスト用ユーザーを作成する

Managed ClickHouse へのインジェスト用に、OTel collector 専用のユーザーを作成し、インジェストの送信先を特定のデータベース (例: otel) に固定することを推奨します。詳しくは、“インジェスト用ユーザーの作成”を参照してください。

​

有効期限 (TTL) を設定する

Managed ClickStack デプロイ向けに、Time To Live (TTL) が適切に設定されていることを確認してください。これはデータの保持期間を制御するものであり、デフォルトの 3 日間は変更が必要になることがよくあります。

​

リソースの見積もり

以下では、想定されるインジェスト量に基づいて、ClickStackのデプロイメントに必要なコンピュートリソースとストレージリソースを見積もるためのモデルを示します。ここで算出される値はあくまで推定値であり、初期ベースラインとして利用してください。これは一律の答えではありません。実際に必要となるリソースは、クエリの複雑さ、同時実行数、保持ポリシー、インジェストスループットの変動によって異なります。リソース使用量は常に監視し、必要に応じてスケールしてください。

すべての数値は非圧縮の生インジェストに基づいています

このページのすべての数値 (スループット (MB/s、TB/月) 、CPUサイジング、ストレージ) は、非圧縮の生インジェスト量、つまりアプリケーションによって生成され、圧縮が適用される前にOpenTelemetry Collectorへ送信されるデータサイズを基準にしています。

これは、既存のログ、トレース、メトリクスのパイプラインから見積もるべき値です。以下の表のストレージ値には、この生データ量に対して想定される10倍の圧縮率がすでに適用されています。

ClickStackをデプロイする際は、インジェストとクエリという2つの独立したワークロードをまかなえるようにコンピュートをプロビジョニングしてください。

Workload	Estimated resources
Ingest	持続的なインジェストスループット10 MB/sごとに1 vCPU
Query	1 QPSごとに1 vCPU、かつ持続的なインジェストスループット10 MB/sごとに1 vCPU

クエリとインジェストの分離

ほとんどのセルフマネージド環境のデプロイメントでは、インジェストとクエリは同じノードを共有します。この場合は、Total CPUsをベースラインとして使用してください。インジェスト用とクエリ用のコンピュートを個別にプロビジョニングする分離スケーリングは、ClickHouse Cloud では separate compute pools aka Warehouses を通じてサポートされています。

前提

• ストレージには10倍の圧縮率を想定しています。これは通常、ログとトレースに対しては保守的な見積もりです。
• クエリSLAは、P50が1.5秒、P99が5秒です。
• ほとんどのクエリは直近のデータに対して実行され、約1時間付近でピークを迎え、約6時間まで裾を引く対数正規分布に従うと想定しています。より古いデータをクエリするために、専用のコンピュートをプロビジョニングしたい場合もあります。ClickHouse Cloud では、使用していないときはこれをアイドル状態にできるため、コストは発生しません。
• クエリ用コンピュートはインジェスト用コンピュートとは独立してスケールできますが、本質的にはインジェスト量と結び付いています。インジェストが増えるにつれてデータ密度が高まり、その結果クエリ時のスキャン量が増加し、それに伴ってクエリ用コンピュートの必要量も増えると想定しています。

以下の表は、1秒あたりメガバイト単位で増加するインジェストスループットに基づくサイジング例と、それに対応する月あたりテラバイト単位のデータ量を示しています。これは、すべてのクエリタイプ (検索、ダッシュボード、アラート) を通じて、ClickStack から平均1 QPSが継続的に発生することを前提としています。

MB/s	TB/month	Ingest CPUs	Query CPUs	Total CPUs	Total Storage (per month) (GB)
10	25.92	1	3	4	2,592
20	51.84	2	6	8	5,184
50	129.6	5	15	20	12,960
100	259.2	10	30	40	25,920
200	518.4	20	60	80	51,840
500	1,296	50	150	200	129,600
1000	2,592	100	300	400	259,200

環境に合わせてサイジングの前提条件をさらに調整する方法については、“環境に合わせたサイジング前提の調整”を参照してください。

​

オブザーバビリティ ワークロードの分離

リアルタイムのアプリケーション分析など、すでに他のワークロードをサポートしている既存の ClickHouse Cloud serviceに ClickStack を追加する場合は、オブザーバビリティ トラフィックを分離することを強く推奨します。

Managed Warehouses を使用して、ClickStack 専用の 子サービス を作成してください。これにより、次のことが可能になります。

• 既存のアプリケーションからインジェスト負荷とクエリ負荷を分離する
• オブザーバビリティ ワークロードを個別にスケールさせる
• オブザーバビリティ クエリが本番分析に影響するのを防ぐ
• 必要に応じて、同じ基盤データセットをサービス間で共有する

この方法により、既存のワークロードに影響を与えることなく、オブザーバビリティ データの増加に応じて ClickStack を独立してスケールさせることができます。

より大規模なデプロイやカスタムのサイジング ガイダンスが必要な場合は、より正確な見積もりについてサポートにお問い合わせください。

ClickStack Open Source

​

ネットワークとポートのセキュリティ

デフォルトでは、Docker Compose はホスト上のポートを公開するため、ufw (Uncomplicated Firewall) などのツールが有効になっている場合でも、コンテナー外部からアクセスできる状態になります。これは、明示的に設定しない限りホストレベルのファイアウォールルールを迂回できる Docker のネットワークスタックの仕様によるものです。

推奨事項：

本番環境で必要なポートのみを公開してください。通常は、OTLPエンドポイント、APIサーバー、フロントエンドが対象です。

例えば、docker-compose.yml ファイル内の不要なポートマッピングを削除またはコメントアウトしてください。

ports:
  - "4317:4317"  # OTLP gRPC
  - "4318:4318"  # OTLP HTTP
  - "8080:8080"  # APIが必要な場合のみ
# ClickHouse の 8123 や MongoDB の 27017 など、内部ポートは公開しないでください。

コンテナーの分離とアクセスのセキュリティ強化の詳細については、Dockerネットワークドキュメントを参照してください。

​

セッションシークレットの設定

本番環境では、セッションデータを保護し改ざんを防ぐため、ClickStack UI (HyperDX) の環境変数 EXPRESS_SESSION_SECRET に強力なランダム値を必ず設定してください。

アプリサービスの docker-compose.yml ファイルに追加する方法を以下に示します。

app:
    image: ${IMAGE_NAME_HDX}:${IMAGE_VERSION}
    ports:
      - ${HYPERDX_API_PORT}:${HYPERDX_API_PORT}
      - ${HYPERDX_APP_PORT}:${HYPERDX_APP_PORT}
    environment:
      FRONTEND_URL: ${HYPERDX_APP_URL}:${HYPERDX_APP_PORT}
      HYPERDX_API_KEY: ${HYPERDX_API_KEY}
      HYPERDX_API_PORT: ${HYPERDX_API_PORT}
      HYPERDX_APP_PORT: ${HYPERDX_APP_PORT}
      HYPERDX_APP_URL: ${HYPERDX_APP_URL}
      HYPERDX_LOG_LEVEL: ${HYPERDX_LOG_LEVEL}
      MINER_API_URL: 'http://miner:5123'
      MONGO_URI: 'mongodb://db:27017/hyperdx'
      NEXT_PUBLIC_SERVER_URL: http://127.0.0.1:${HYPERDX_API_PORT}
      OTEL_SERVICE_NAME: 'hdx-oss-api'
      USAGE_STATS_ENABLED: ${USAGE_STATS_ENABLED:-true}
      EXPRESS_SESSION_SECRET: "super-secure-random-string"
    networks:
      - internal
    depends_on:
      - ch-server
      - db1

openssl を使用して強力なシークレットを生成できます：

openssl rand -hex 32

シークレットをソース管理にコミットしないようにしてください。本番環境では、環境変数管理ツール (例：Docker Secrets、HashiCorp Vault、環境固有のCI/CD設定など) の使用を検討してください。

​

インジェストのセキュリティ保護

すべてのインジェストは、ClickStack が提供する OpenTelemetry (OTel) collector の OTLP ポートを経由して行う必要があります。デフォルトでは、起動時に生成されるセキュアなインジェスト API key が必要です。この API key は OTel ポートへのデータ送信時に必要となり、HyperDX UI の Team Settings → API Keys から確認できます。

また、OTLPエンドポイントでのTLS有効化も推奨します。

​

インジェストユーザーの作成

OTel collector がClickHouseにデータを取り込むための専用ユーザーを作成し、インジェストが特定のデータベース (例：otel) に送信されるよう設定することを推奨します。詳細については、「インジェストユーザーの作成」を参照してください。

​

ClickHouse

自身でClickHouseインスタンスを管理するユーザーは、以下のベストプラクティスを遵守してください。

​

セキュリティのベストプラクティス

独自の ClickHouse インスタンスを管理している場合は、TLS を有効化し、認証を強制し、アクセスを堅牢化するためのベストプラクティスに従うことが重要です。実際の設定ミスとその回避方法については、このブログ記事を参照してください。

ClickHouse OSSは、堅牢なセキュリティ機能をすぐに利用できる形で提供しています。ただし、これらの機能を使用するには設定が必要です。

• config.xml の tcp_port_secure と <openSSL> を使用して TLS を有効にします。guides/sre/configuring-tls を参照してください。
• default ユーザーに強力なパスワードを設定するか、無効にします。
• 明示的に意図している場合を除き、ClickHouse を外部に公開しないでください。デフォルトでは、listen_host を変更しない限り、ClickHouse は localhost でのみ待ち受けます。
• 認証方式 (パスワード、証明書、SSHキー、または外部認証機構など) を使用します。
• アクセスを制限するには、IP フィルタリングと HOST 句を使用します。詳細は sql-reference/statements/create/user#user-host を参照してください。
• きめ細かな権限を付与するには、ロールベースアクセス制御 (RBAC) を有効にします。operations/access-rightsを参照してください。
• クォータ、設定プロファイル、および読み取り専用モードを使用して、クォータや各種制限を適用します。
• 保存データを暗号化し、安全な外部ストレージを使用してください。operations/storing-data および cloud/security/CMEK を参照してください。
• 認証情報をハードコードしないでください。 ClickHouse Cloud では、named collections または IAM ロールを使用してください。
• アクセスとクエリを監査するには、システムログ と セッションログ を使用します。

ユーザーの管理およびクエリ・リソース制限の設定については、外部認証機能およびクエリ複雑度の設定も参照してください。

​

ClickStack UIのユーザー権限

ClickStack UI用のClickHouseユーザーは、以下の設定を変更できるreadonlyユーザーであれば十分です：

• max_rows_to_read (少なくとも100万までは)
• read_overflow_mode
• cancel_http_readonly_queries_on_client_close
• wait_end_of_query

デフォルトでは、OSSおよびClickHouse Cloudの両方でdefaultユーザーにこれらの権限が付与されていますが、これらの権限を持つ新規ユーザーを作成することを推奨します。

​

有効期限 (TTL) の設定

ClickStack のデプロイメントに合わせて、有効期限 (TTL) が適切に設定されていることを確認してください。これはデータの保持期間を制御する設定で、デフォルトの 3 日間は多くの場合変更が必要です。

​

MongoDBガイドライン

公式のMongoDBセキュリティチェックリストに従ってください。