インサイトデータの連携

このドキュメントでは、インサイトのデータをサードパーティツールと連携させる方法について説明します。 CircleCI では現在、 Datadog と Sumo Logic との連携をサポートしています。

CircleCI では、Webhook を使って Datadog にデータを送ることができます。

1. CircleCI アプリで、各プロジェクトの横の省略記号(…)をクリックし、Project Settings > Webhooks の順にクリックします。
   • Webhook URL: https://webhook-intake.datadoghq.com/api/v2/webhook/?dd-api-key=<API_KEY> where <API_KEY> が Datadog の API キーです。
   • Name: Datadog CI Visibility または指定したい識別名を入力します。
   • Events: Workflow Completed と Job Completed を選択します。
   • Certificate verifications: このチェックを有効にします。
2. Add Webhook をクリックして新しい Webhook を保存します。

Datadog にサインインし、パイプラインとパイプラインの実行ページにアクセスし、ワークフローの完了後にデータが入力されることを確認します。

注: パイプラインのページでは各リポジトリのデフォルトのブランチのデータのみが表示されます。

Sumo Logic 用の CircleCI アプリでは、継続的インテグレーションやデプロイパイプラインのパフォーマンスやヘルス状態を追跡するための高度なビューを提供しています。

このダッシュボードを使って以下を実行します。

• パフォーマンス、アクティビティ、ヘルスの状態をリアルタイムで監視および時間の経過に伴った追跡
• 最適化の余地の特定

含まれているダッシュボードパネルを使用して、パイプラインに関するインサイトを得ることができます。 特定のプロジェクトまたはジョブの各パネルを、任意の期間フィルタリングします。 ダッシュボードパネルには以下が表示されます：

• 実行したジョブの合計数
• ジョブのヘルス (成功率%）
• 概要
• プロジェクト毎の実行ジョブ
• 1日のパフォーマンス
• 1日のジョブ数
• 最近失敗したジョブ 5 つ
• 最近失敗したワークフロー 5 つ
• 時間がかかったワークフロートップ 10 （平均）
• 実行時間の長いジョブトップ 10
• 1日の平均ジョブ実行時間

CircleCI ダッシュボードは、ダッシュボードのホームページからアプリケーション カタログを使用してインストールできます。

ダッシュボードは CircleCI Sumo Logic Orb を介してデータを受け取ります。 この Orb は、追跡するプロジェクトに含まれている必要があります。

Sumo Logic を使ってデータを収集し可視化するには、まずメトリクスデータを Sumo Logic に送るよう CircleCI Webhook を設定します。

Sumo Logic の Configuring a Hosted Collector についてのドキュメントに従います。

CircleCI Webhook を送付する URL を取得し、コレクターに記録するには、 HTTP ソースを追加する必要があります。

完了したら、生成された「HTTP ソースアドレス」をコピーします。 このリンクはその後いつでも Sumo Logic から再取得することができます。 この URL を次のステップで CircleCI Webhook の UI に入力します。

トラックするプロジェクト毎に、Webhook が先述の HTTP ソースアドレスに送信されるように設定します。 Webhook の設定に関するドキュメントに従ってください。

Webhook を設定する際は、必ず「workflow-completed」イベントと「job-completed」イベントの両方を含めてください。

データ収集の設定は完了しま他ので、次に、 事前設定された検索機能と CI パイプラインにインサイトを送るダッシュボードを使用するために CircleCI 用 Sumo Logic アプリをインストールします。

1. アプリカタログから CircleCI アプリを見つけてインストールします。 インストールの前にこのアプリに入っているダッシュボードのプレビューを見るには、Preview Dashboards をクリックします。
2. 使用しているサービスのバージョンを選択し、 Add to Library をクリックします。 バージョンの選択は現在いくつかのアプリにのみで可能です。 詳細については、 Install the Apps from the Library を参照して下さい。
3. アプリをインストールするには、以下のフィールドに入力してください。
   • アプリ名: 既存の名前をそのまま使用することも、アプリ用の名前を入力することもできます。
   • データソース: データソースに下記のいずれかのオプションを選択します。
   • Source Category を選択び、リストからソースカテゴリーを選びます。
   • Enter a Custom Data Filter を選び、アンダースコアで始まるカスタムソースカテゴリを入力します。 例: (_sourceCategory=MyCategory) - 高度な設定: ライブラリ内の場所 (デフォルトではライブラリの個人フォルダ) を選択するか、New Folder をクリックして新しいフォルダを追加します。
4. Add to Library をクリックします。

アプリがインストールされたら、個人フォルダーまたはライブラリ内でデフォルトとして設定した場所に表示されます。 これで、お客様の組織でこのアプリを共有することができます。 パネルが自動的に入力されます。 各パネルには、時間範囲のクエリに合致しパネルの作成以降に受信したデータが徐々に入力されることに注意してください。 結果はすぐには表示されませんが、少し時間が経つと、すべてのグラフとマップが表示されます。