JReport Designer で Sentry のデータを連携利用

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
JReport Designer で Sentry のデータ をもとにチャートとレポートを作成。



CData JDBC Driver for Sentry のデータ を使えば、ダッシュボードやレポートから Sentry をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで Sentry のデータ のライブデータにアクセスできます。この記事では、JReport Designer で Sentry のデータ に JDBC データソースとして接続し、Sentry のデータ のデータをもとにレポートを作成する方法を説明します。

Sentry ののデータに接続

  1. C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。
    ...
    set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Sentry 2016\lib\cdata.jdbc.api.jar;
    ...
    
  2. File メニューから New、Data Source と進み、新しいデータソースを作成します。
  3. 表示されるダイアログでデータソース名を入力し(例:CData JDBC Driver for Sentry)、JDBC を選択して OK をクリックします。
  4. Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
    • Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
      cdata.jdbc.api.APIDriver
    • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。

      API キー認証の設定

      Sentry はトークンベースの認証を使用します。Auth Token を取得するには、以下のステップで進めます:

      1. https://sentry.io で Sentry アカウントにログインします
      2. Settings > Auth Tokens に移動します
      3. 「Create New Token」をクリックします
      4. 必要なスコープを選択して「Create Token」をクリックします
      5. 生成されたトークンをコピーします(一度しか表示されません)

      Auth Token を取得したら、以下の接続プロパティを設定します:

      • AuthScheme:APIKey に設定します。
      ProfileSettings 接続プロパティには以下を設定します:
      • APIKey:Sentry の Auth Token に設定します。
      • OrganizationId:Sentry の組織スラッグまたは ID に設定します。

      接続文字列の例

      Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
      

      Sentry への接続

      認証を設定すると、Sentry に接続して、Organizations、Projects、Issues、Events などの利用可能なテーブルからデータをクエリできます。

      組み込みの接続文字列デザイナー

      JDBC URL の構築には、Sentry JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

      java -jar cdata.jdbc.api.jar
      

      接続プロパティを入力し、接続文字列をクリップボードにコピーします。

      JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。

      一般的な JDBC URL は次のとおりです。

      jdbc:api:Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
    • User: 認証に使用するユーザー名です。通常は空白のままにします。
    • Password: 認証に使用するパスワードです。通常は空白のままにします。
  5. Add Table ダイアログで、レポートに含めるテーブル(または、このデータソースを使用する今後のレポート用のテーブル)を選択し、Add をクリックします。

    テーブルの読み込みが完了したら Done をクリックします。

  6. Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース(CData JDBC Driver for Sentry)を展開()し、Queries を右クリックして Add Query を選択します。
  7. Add Table/View/Query ダイアログで、JDBC URL と Tables を展開()し、クエリで使用するテーブルを選択して OK をクリックします。
  8. Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
    SELECT ,  FROM UserOrganizations WHERE  = ''
    

    クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで Sentry のデータ を新規または既存のレポートに追加する準備が整いました。

    NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。

Sentry ののデータをレポートに追加

これで Sentry のデータ を使用したレポートを作成する準備が整いました。

  1. File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
  2. Query を選択します(または新規作成します。上記を参照)。
  3. クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。
  4. レポートの View タブをクリックして、チャートを表示します。

はじめる準備はできましたか?

API Driver で Sentry のライブデータに接続

Sentry に接続