JasperReports Server で RabbitMQ のレポートを作成

CData JDBC Driver for RabbitMQ を使用すると、企業全体で RabbitMQ のデータ へのアクセスを提供できます。この記事では、JasperReports Server にドライバーをデプロイし、RabbitMQ のデータ のビジネスビューであるレポートドメインに基づいたシンプルなレポートを作成する方法を説明します。

ドライバー JAR のデプロイ

以下の手順に従って、JasperReports Server にドライバー JAR をデプロイします。この手順は RabbitMQ と JasperReports Server にバンドルされている Tomcat サーバーに固有のものです。Tomcat ではなく JBoss AS 7 を使用している場合は、標準的なプロセスに従って JBoss への RabbitMQ JDBC Driver のデプロイを行ってください。

1. インストールディレクトリの lib サブフォルダにあるドライバー JAR と .lic ファイルを、JasperReports Server インストールディレクトリ内の apache-tomcat フォルダの lib サブフォルダにコピーします。

2. apache-tomcat -> webapps -> jasperserver-pro -> META-INF に移動し、以下のリソースエントリを context.xml ファイルに追加します。

   
   <Resource name="jdbc/api"   auth="Container" type="javax.sql.DataSource" driverClassName="cdata.jdbc.api.APIDriver"  url="jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;" maxActive="20" maxIdle="10" maxWait="-1" factory="com.jaspersoft.jasperserver.tomcat.jndi.JSCommonsBasicDataSourceFactory"/>
   

   JDBC URL（url 属性）に必要な接続プロパティを指定します。

   RabbitMQ Management HTTP API について

   RabbitMQ は、複数のメッセージングプロトコルをサポートするオープンソースのメッセージブローカーです。RabbitMQ Management HTTP API は、RabbitMQ サーバーの管理データと監視データに HTTP 経由でアクセスする手段を提供します。この API では、仮想ホスト、エクスチェンジ、キュー、バインディング、コネクション、チャネル、コンシューマー、ユーザー、権限、ポリシー、クラスター全体の統計情報を取得できます。

   HTTP API を利用するには、RabbitMQ サーバーで Management プラグインを有効化する必要があります。デフォルトでは、管理インターフェースはポート 15672 でリッスンします。

   Basic 認証の設定

   RabbitMQ Management HTTP API は HTTP Basic 認証を使用します。RabbitMQ 管理ユーザーのユーザー名とパスワードを指定する必要があります。

   管理 API へのアクセスを有効にするには、以下のステップで進めます：

   1. サーバーで RabbitMQ Management プラグインが有効になっていることを確認します（rabbitmq-plugins enable rabbitmq_management）。
   2. 既存の管理ユーザーを使用するか、適切な管理タグ（management、policymaker、monitoring、または administrator）を持つユーザーを作成します。
   3. RabbitMQ Management HTTP API の完全なベース URL を控えておきます（例：http://localhost:15672）。

   RabbitMQ サーバーを設定したら、以下の接続プロパティを設定して接続します：

   • AuthScheme：Basic に設定します。
   • URL：RabbitMQ Management HTTP API のベース URL に設定します（例：http://localhost:15672）。
   • User：RabbitMQ の管理ユーザー名に設定します（例：guest）。
   • Password：RabbitMQ の管理パスワードに設定します。

   接続文字列の例：

   Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
   

   利用可能なテーブル

   RabbitMQ プロファイルでは、以下のテーブルにアクセスできます：

   • Overview - クラスター全体の統計情報と RabbitMQ ノードに関する情報
   • Nodes - RabbitMQ クラスター内の個々のノードに関する情報
   • NodeMemory - 特定のクラスターノードの詳細なメモリ使用状況の内訳
   • Connections - ブローカーへのすべてのオープンな AMQP コネクションの一覧
   • Channels - すべてのコネクションにわたるオープンな AMQP チャネルの一覧
   • Consumers - すべてのキューに登録されたコンシューマーの一覧
   • Exchanges - すべての仮想ホストで宣言されたエクスチェンジの一覧
   • Queues - すべての仮想ホストで宣言されたキューの一覧
   • Bindings - エクスチェンジとキュー間のすべてのバインディングの一覧
   • VirtualHosts - ブローカーに設定された仮想ホストの一覧
   • VhostPermissions - 特定の仮想ホスト内のユーザー権限
   • Users - すべての RabbitMQ ユーザーの一覧
   • Permissions - すべての仮想ホストにわたる全ユーザーの権限レコード
   • TopicPermissions - 全ユーザーのトピックレベルの権限レコード
   • Policies - 仮想ホスト内のキューおよびエクスチェンジに適用されたポリシーの一覧
   • OperatorPolicies - 仮想ホスト内のキューに適用されたオペレーターポリシーの一覧
   • Parameters - 仮想ホストごとのコンポーネントパラメータ（例：federation、shovel）の一覧
   • GlobalParameters - すべての仮想ホストに適用されるグローバルパラメータの一覧
   • VhostLimits - 特定の仮想ホストに設定されたリソース制限
   • UserLimits - 特定のユーザーに設定されたリソース制限
   • FeatureFlags - フィーチャーフラグの一覧と、ノード上での有効／無効の状態
   • DeprecatedFeatures - 非推奨機能の一覧と、その使用状態
   • AuthAttempts - ノードの認証試行統計
   • ClusterName - RabbitMQ クラスターの名前
   • WhoAmI - 現在認証されている管理ユーザーに関する情報
   • ExchangeBindingsSource - 特定のエクスチェンジがソースとなっているバインディング
   • ExchangeBindingsDestination - 特定のエクスチェンジが宛先となっているバインディング
   • QueueBindings - 仮想ホスト内の特定のキューのバインディング

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

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

   java -jar cdata.jdbc.api.jar
   

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

   

   JDBC URL を設定する際に、Max Rows 接続プロパティを設定することもできます。これにより返される行数が制限され、レポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。

3. jasperserver-pro -> WEB-INF に移動し、以下の参照を web.xml ファイルに追加します。

   
     RabbitMQ のデータ JSP
     jdbc/api
     javax.sql.DataSource
     Container
   
   

4. サーバーを再起動します。

RabbitMQ JDBC データソースの作成

以下の手順に従って、RabbitMQ JDBC Driver を JDBC データソースにマッピングします。

1. JasperReports Server にログインし、Create -> Data Source をクリックします。
2. Type メニューで、JNDI Data Source を選択します。
3. Service Name ボックスに、web.xml ファイルのリソース定義で指定した JNDI ルックアップを入力します。この例では、ルックアップは「jdbc/api」です。
4. Save をクリックしてデータソースを作成します。

ドメインの作成

ドメインは、レポート作成者に関連するビジネスビューを提供するメタデータおよびアクセス制御レイヤーです。以下の手順に従って、RabbitMQ のカラムを選択し、フィルタを適用し、SQL を実行してドメインを作成します。

1. Create -> Domain をクリックします。ドメインの ID を入力し、保存場所を選択します。
2. Data Source セクションで Browse をクリックし、作成した RabbitMQ データソースを選択します。
3. Domain Design セクションで、Create with Domain Designer をクリックします。
4. テーブルが含まれるスキーマを選択します。
5. Tables タブで、Data Source ペインからテーブルを選択し、矢印をクリックして Selected Tables ペインに追加します。
6. Derived Tables タブでは、SQL クエリに基づいてドメインを定義できます。例えば、

     SELECT ,  FROM AuthAttempts WHERE NodeName = 'rabbit@hostname'
     

7. Joins タブでは、結合条件を構築するカラムを選択し、結合タイプを選択することでテーブルを結合できます。
8. Pre-Filters タブでは、カラムをドラッグ＆ドロップして、ドメインを通じて公開されるデータをフィルタする検索条件を定義します。
9. Display タブで、ユーザーに提示されるデータセットに RabbitMQ データを選択します。
10. OK をクリックして変更を確定し、Submit をクリックしてドメインを作成します。

リアルタイムでデータを探索

ドメインを作成したら、データに接続する準備が整います。以下の手順に従って、Ad Hoc Editor で Ad Hoc ビューを作成します。

1. Create -> Ad Hoc View をクリックします。
2. 表示されるダイアログで、作成した RabbitMQ ドメインを選択します。
3. Choose Data ページで、ビューで使用するカラムを選択します。Pre-Filters セクションでは、選択したフィールドに基づいてフィルタを作成できます。Display セクションでは、ドメインで表示されるカラム情報を変更できます。
4. ウィザードが完了したら、ビュータイプを選択し、ビューにカラムを追加します。JasperSoft はドライバーのメタデータを使用して、データ型に基づいて利用可能なディメンションとメジャーを検出します。ディメンションとメジャーを Columns ボックスと Rows ボックスにドラッグします。メジャーを右クリックして集計計算を変更できます。Filters セクションで Columns スライダーを目的のデータレベルにドラッグします。
5. ビューの設計中にデータの更新にアクセスするには、設計モードのツールバーでメニュー選択を Sample Data から Full Data に変更します。変更を行うと、JasperSoft Server はドライバーに対して基になる SQL クエリを実行します。
6. ビューを保存します。

リアルタイムレポートの作成

これで、JasperSoft Server でホストされるレポートを作成できます。Ad Hoc Editor から作成するには、Save Ad Hoc View をクリックし、Create Report をクリックします。