Insights データの連携

概要

Insights ダッシュボードのデータを、サードパーティ プロバイダー製品と連携する方法について説明します。

Sumo Logic とのインテグレーション

Sumo Logic を使用すると、CircleCI 上のすべてのジョブを追跡し、その分析データを可視化できます。 そのためには、Sumo Logic パートナー インテグレーション サイトから、Sumo Logic Orb と Sumo Logic アプリケーション インテグレーションを使用します。

Sumo Logic の CircleCI ダッシュボード

ヘッダー

以下の情報が表示されます。

  • 合計ジョブ数
  • 合計成功ジョブ数
  • 合計失敗ジョブ数
  • ジョブの結果
  • ジョブ別の平均実行時間 (秒単位)
  • プロジェクト別のジョブ数
  • 最新のジョブ (直近 10 個)
  • 時間のかかった失敗ジョブ上位 10 個 (秒単位)
  • 時間のかかった成功ジョブ上位 10 個 (秒単位)

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

ヘッダー

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

Sumo Logic Orb

Sumo Logic Orb の最新版は、CircleCI Orb レジストリで提供されています。

1. Sumo Logic Orb をインポートする

Sumo Logic Orb をプロジェクトに追加するには、以下のようにトップ レベルの orbs キーを記述し、circleci/sumologic@x.y.z をインポートします (x.y.z は上記リンクの最新バージョンの番号で置き換えてください)。

orbs:
  sumologic: circleci/sumologic@x.y.z
2. ワークフローに workflow-collector を追加する

workflow-collector ジョブはワークフローと同時に並列で実行され、ワークフロー内のすべてのジョブが完了するまで Sumo Logic に分析データを送信します。

version: 2.1
workflows:
  build-test-and-deploy:
    jobs:
      - sumologic/workflow-collector # このジョブを追加してワークフローを追跡します
      - build
      - test:
          requires:
            - build
      - deploy:
          requires:
            - test
3. ソース コレクターを 2 つ作成する

Sumo Logic で、HTTPS URL を返す 2 つのソース コレクターを作成する必要があります。 この HTTPS URL にジョブ データが送信されます。

作成する必要があるのは、circleci/job-collectorcircleci/workflow-collector という名前のコレクターです。

以下の手順で 2 つのソース コレクターを作成します。

  1. ダッシュボードで [Setup Wizard (セットアップ ウィザード)] を選択します。
  2. [Set Up Streaming Data (ストリーミング データのセットアップ)] を選択します。
  3. 一番下までスクロールし、[All Other Sources (他のすべてのソース)] を選択します。
  4. [HTTPS Source (HTTPS ソース)] を選択します。
  5. [Source Category (ソース カテゴリ)] に、前述した 2 つの名前のいずれかを入力します。
  6. 出力された URL を保存します。
4. 環境変数を追加する

ステップ 3 で生成された各 URL に対して、対応する環境変数を作成します。

対応する環境変数は以下の 2 つです。

  • JOB_HTTP_SOURCE
  • WORKFLOW_HTTP_SOURCE

プロジェクトに環境変数を追加する方法

これにより、Orb が Sumo Logic ダッシュボードにリンクされます。

各ジョブが CircleCI で実行されると、Sumo Logic ダッシュボードはデータの入力を開始します。

関連項目

Orb の使用とオーサリングの詳細については、「Orb の概要」を参照してください。



Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.