ClickStack Open Source の使用を開始する

ClickStack Open Source をローカルで実行し、その OpenTelemetry Collector 経由でテストイベントを送信して、イベントが ClickStack UI で利用可能であることを確認します。 ClickStack Open Source では、ClickHouse backend、ClickStack UI、インジェストパイプラインを実行・管理します。オールインワンイメージには、これらのコンポーネントと MongoDB がローカルでの評価・テスト用に単一の Docker コンテナーへバンドルされています。

Managed ClickStack も利用できます。詳細は Managed ClickStack を参照してください。

以下の手順では、認証済みのオールインワンイメージを使用します。アカウントを作成せずにローカル UI を利用する場合は、代わりに Docker を使用するローカルモードのウォークスルーに従ってください。

始める前に

Dockerをインストールし、以下のポートが使用可能であることを確認します。

ClickStack UI 用: 8080
gRPC 経由の OTLP 用: 4317
HTTP 経由の OTLP 用: 4318
ClickHouse HTTP インターフェイス用: 8123

継続的なワークロードや本番ワークロードについては、オープンソースでのデプロイメントオプションおよび本番環境への移行を参照してください。

オールインワンイメージで ClickStack Open Source をセットアップする

ClickStack を起動する

オールインワンイメージを実行します。

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest

コンテナーはフォアグラウンドで実行されます。この端末は開いたままにし、このガイドの以降のコマンドは別の端末で実行してください。

データと設定を永続化する

コンテナーを削除した後も ClickStack の設定、ClickHouse のデータ、ClickHouse のログを保持するには、代わりに次のコマンドを実行します。

docker run \
  --name clickstack \
  -p 8123:8123 \
  -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" \
  clickhouse/clickstack-all-in-one:latest

$(pwd) は現在のディレクトリに展開されます。このコマンドにより、永続データはその場所の .volumes ディレクトリに保存されます。

ClickStack を開く

ClickStack の起動後、http://localhost:8080 を開き、アカウントを作成します。ClickStack はバンドルされた ClickHouse インスタンスに自動的に接続し、ログ、トレース、メトリクス、セッション用のデータソースを作成します。

インジェスト API key をコピーする

左側のメニューの Get Started セクションで Add Data を選択し、Ingestion API Key をコピーします。バンドルされた OpenTelemetry Collector に送信するテレメトリーには、このキーを authorization ヘッダーに含める必要があります。

テストデータを送信する

別の端末で、インジェスト API key をエクスポートします。

export CLICKSTACK_API_KEY=<your_ingestion_api_key>

現在のタイムスタンプを含む OTLP ログを送信します。

NOW_NANO="$(date +%s)000000000"

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  -H "authorization: ${CLICKSTACK_API_KEY}" \
  --data-binary @- <<EOF
{
  "resourceLogs": [{
    "resource": {
      "attributes": [{
        "key": "service.name",
        "value": {"stringValue": "clickstack-docs-test"}
      }]
    },
    "scopeLogs": [{
      "scope": {"name": "clickstack-docs-test"},
      "logRecords": [{
        "timeUnixNano": "${NOW_NANO}",
        "severityText": "INFO",
        "body": {"stringValue": "ClickStack ingestion test"}
      }]
    }]
  }]
}
EOF

リクエストが成功すると、HTTP/1.1 200 OK が返されます。

インジェストを確認する

ClickStack で Search ビューを開き、ClickStack ingestion test を検索します。検索結果には、サービス名が clickstack-docs-test のテストイベントが表示されます。

これで、ローカルの ClickStack インスタンス、動作するインジェストエンドポイント、ClickStack で確認できるテストイベントが用意されました。

次のステップ

アプリケーションとインフラストラクチャのデータを送信する

ClickStack に送信するデータに応じて、ガイドを選択してください。

アプリケーションをインストルメントする

サポート対象の OpenTelemetry SDK を使用して、アプリケーションのトレースとログを送信します。

ホストログを収集する

エージェントの役割で実行される OpenTelemetry Collector からホストログを転送します。

Kubernetes を監視する

Kubernetes クラスターからログ、メトリクス、トレースを収集します。

その他のインテグレーションを確認する

追加のアプリケーションやテレメトリーソース向けのガイドを確認します。

サンプルデータを探索する

サンプルデータセットを使用して、より充実したテレメトリーでClickStackを探索できます。

サンプルログ、トレース、メトリクス

公開デモのデータを読み込み、issueを診断します。

ローカルログとメトリクス

macOSまたはLinuxでローカルファイルとシステムメトリクスを収集します。

Dockerをインストールせずに事前に読み込まれたデータを探索するには、ホスト型ClickStackデモを使用します。

合成データを生成する

既存のアプリケーションやデータセットがない場合でも、ジェネレーターを使用してインジェストをテストできます。

otelgen でデータを生成する

合成 OTLP ログ、トレース、メトリクスを短時間に送信します。

telemetrygen でデータを生成する

複数のサービスにわたって、設定可能な OpenTelemetry シグナルを生成します。

ClickStack のすべてのサンプルデータとデモを参照してください。

本番運用の準備

ClickStack を継続的なワークロードで使用する前に、デプロイメントおよび本番運用に関するガイダンスを確認してください。

本番環境への移行

インジェスト用認証情報、セキュリティ、保持期間、運用に関するガイダンスを確認します。

デプロイメントモデルを選択する

環境に適したオープンソースのデプロイメントオプションを比較します。

はじめに

機能

ClickStack の管理

ガイド

インテグレーションパートナー

ClickStack Open Source の使用を開始する

始める前に

オールインワンイメージで ClickStack Open Source をセットアップする

ClickStack を起動する

ClickStack を開く

インジェスト API key をコピーする

テストデータを送信する

インジェストを確認する

次のステップ

アプリケーションとインフラストラクチャのデータを送信する

アプリケーションをインストルメントする

ホストログを収集する

Kubernetes を監視する

その他のインテグレーションを確認する

サンプルデータを探索する

サンプルログ、トレース、メトリクス

ローカルログとメトリクス

合成データを生成する

otelgen でデータを生成する

telemetrygen でデータを生成する

本番運用の準備

本番環境への移行

デプロイメントモデルを選択する

​始める前に

​オールインワンイメージで ClickStack Open Source をセットアップする

ClickStack を起動する

ClickStack を開く

​インジェスト API key をコピーする

テストデータを送信する

インジェストを確認する

​次のステップ

​アプリケーションとインフラストラクチャのデータを送信する

アプリケーションをインストルメントする

ホストログを収集する

Kubernetes を監視する

その他のインテグレーションを確認する

​サンプルデータを探索する

サンプルログ、トレース、メトリクス

ローカルログとメトリクス

​合成データを生成する

otelgen でデータを生成する

telemetrygen でデータを生成する

​本番運用の準備

本番環境への移行

デプロイメントモデルを選択する

始める前に

オールインワンイメージで ClickStack Open Source をセットアップする

インジェスト API key をコピーする

次のステップ

アプリケーションとインフラストラクチャのデータを送信する

サンプルデータを探索する

合成データを生成する

本番運用の準備