Pentaho Report Designer でCircleCI のデータを連携利用
CData JDBC Driver for CircleCI のデータ を使えば、ダッシュボードやレポートからリアルタイムデータにアクセスできます。この記事では、CircleCI のデータにJDBC データソースとして接続し、Pentaho でCircleCI のデータをもとにしたレポートを公開する方法を説明します。
接続してレポートを作成
- インストールディレクトリのlib サブフォルダ内にあるドライバーのJAR ファイルを、Pentaho ディレクトリ内の\Report-Designer\lib\jdbc\ フォルダにコピーします。
- \Report-Designer\ フォルダ内のreport-designer.bat ファイルを実行してReport-Designer UI を開きます。
Data -> Add Data Source -> Advanced -> JDBC（Custom）をクリックし、新しいCircleCI 接続を作成して、ドライバーで新しいデータソースを作成します。 表示されるダイアログで、以下のように接続プロパティを設定します。
Custom Connection URL property：JDBC URL を入力します。JDBC URL はjdbc:api: で始まり、その後にセミコロン区切りで接続プロパティを指定します。
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';
組み込みの接続文字列デザイナー
JDBC URL の構成については、CircleCI JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.api.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
JDBC URL を設定する際、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限されます。特にレポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。
一般的なJDBC URL は次のとおりです：
jdbc:api:Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
- Custom Driver Class Name：cdata.jdbc.api.APIDriver を入力します。
- User Name：認証に使用するユーザー名。
- Password：認証に使用するパスワード。
レポートにCircleCI のデータを追加
CircleCI のデータをもとにレポートを作成する準備が整いました。
-
レポートにCircleCI のソースを追加します。Data -> Add Data Source -> JDBC をクリックしてデータソースを選択します。
クエリを設定します。この記事では以下のクエリを使用します：
SELECT , FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'
- レポートにチャートをドラッグし、ダブルクリックしてチャートを編集します。レポートを実行してチャートを表示します。このクエリの結果を使用して、Artifacts テーブルのシンプルなチャートを作成できます。
- 最後に、レポートを実行してチャートを確認します。
