DBxtra でCircleCI のデータを使ってダッシュボードを構築
CData のCircleCI 用 ODBC ドライバーは、ODBC 標準経由でCircleCI のリアルタイムデータにアクセスし、使い慣れた SQL クエリで各種 BI、レポート、ETL ツールからCircleCI のデータを利用可能にします。この記事では、汎用 ODBC データプロバイダーとしてCircleCI に接続し、DBxtra でCircleCI のデータを基にしたチャート、レポート、ダッシュボードを作成する方法を解説します。
CircleCI のデータへの接続設定
- まだ設定していない場合は、データソース名（DSN）で必要な接続プロパティを指定します。DSN の設定は組み込みの Microsoft ODBC データソースアドミニストレーターを使用して行えます。これはドライバーインストールの最終ステップでもあります。Microsoft ODBC データソースアドミニストレーターを使用して DSN を作成・設定する方法については、ヘルプドキュメントの「はじめに」の章をご参照ください。
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';
DSN を設定する際には、Max Rows 接続プロパティも設定することをお勧めします。これにより返される行数が制限され、レポートやビジュアライゼーションの設計時にパフォーマンスを向上させるのに役立ちます。
- DBxtra アプリケーションを開き、New メニューから Project をクリックしてプロジェクト名を入力します。
- Data Connection Type として ODBC Connection を選択します。
- Data Source の参照オプション（）をクリックします。
- Data Link Properties ウィンドウの Provider タブで、Microsoft OLE DB Provider for ODBC Drivers を選択します。
- Connection タブで、Data Source Name と使用する初期カタログ（CData）を選択します。
- 接続名を入力し、適切なユーザーグループを選択します。
- プロジェクト内で接続をダブルクリックしてデータに接続します。
CircleCI のデータでダッシュボードを作成
これでCircleCI のデータを使ってダッシュボードを作成する準備が整いました。
- プロジェクト内の Report Objects を右クリックし、New Report Object を選択します。
- 新しい Report Object で、リンクをクリックしてクエリを作成します。
- Select Data Connection ウィンドウで、先ほど作成したデータ接続を選択します。
- Query タブで、接続オブジェクトを展開し、ダッシュボードに含めたいテーブル、ビュー、特定のカラムを選択します。検索条件を指定したり、JOIN や集計を含む複雑なクエリを作成することもできます。
- Dashboard タブで、ダッシュボードのビジュアライゼーションと機能を選択します。クエリからのデータ値をダッシュボード項目の適切なフィールド（Values、Series など）に割り当てます。
新しいダッシュボードが作成されたら、CircleCI のデータ分析を開始できます。CircleCI 用 ODBC ドライバーのおかげで、ダッシュボードを更新すればソースで行われた変更を即座に確認できます。同様に、常に最新のCircleCI データを反映したレポートを作成・表示できます。