データ可視化ソリューション「Reveal」から CircleCI に接続する方法
CData API Server を使って、Reveal にCircleCI データをフィードして、ビジュアライズを実現できます。コネクターによりリアルタイムデータ連携が可能になり、リフレッシュ操作で最新のデータを取得可能になります。この記事では、Reveal からCircleCI のデータに接続しビジュアライズする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなCircleCI OData サービスを作成していきましょう。
CircleCI への接続
Reveal からCircleCI のデータを操作するには、まずCircleCI への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「CircleCI」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、CircleCI への接続設定を行っていきましょう！
-
API キー認証の設定
CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：CircleCI のパーソナル API トークンに設定します。
接続文字列の例：
Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：CircleCI のパーソナル API トークンに設定します。
接続文字列の例：
Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
API Server のユーザー設定
次に、API Server 経由でCircleCI にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
CircleCI 用のAPI エンドポイントの作成
ユーザーを作成したら、CircleCI のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でCircleCI への接続を設定してユーザーを作成し、API Server でCircleCI データのAPI を追加しました。これで、OData 形式のCircleCI データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
ダッシュボードの作成
それでは実際に可視化を行っていきます。「Reveal」ではダッシュボードという単位でいくつかのグラフを配置して、構成していきます。
- Revealにログインし、「新規」→「ダッシュボード」をクリックします。
- データソースから「ODataフィード」を選択し
- API ServerのAPIエンドポイントURLを指定し、資格情報を入力します。 URLは「https://XXXXXXX/api.rsc/」といったように末尾が「api.rsc」で終わっているものを入力します。
- 資格情報は「汎用資格情報」を選択し、
- あらかじめ作成しておいたAPI Serverのユーザー名と認証トークンをそれぞれ指定します。
- 認証完了後、エンティティセットを選択する画面に移動するので、取得したい任意のエンティティセットを選択します。
- これでダッシュボードを作成する準備が整いました。あとは Reveal の機能を使って、CircleCI・API Serverから取得したデータを可視化・分析することができます。
- 以下のようなグラフを作成することができました。
このように CircleCI 内のデータをAPI を書くことなく Reveal 上で処理することができるようになります。
おわりに
これで、リアルタイムCircleCI のデータから簡単なダッシュボードが作成できました。CircleCI （および150 を超えるほかのソース）からのOData フィードの作成方法の詳細については、API Server のページにアクセスしてください。30 日間無料トライアルをダウンロードしてOData API を使用するツールでCircleCI のデータをリアルタイムに活用しましょう。