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

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

RabbitMQ ののデータに接続

1. C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for RabbitMQ 2016\lib\cdata.jdbc.api.jar;
   ...
   

2. File メニューから New、Data Source と進み、新しいデータソースを作成します。
3. 表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for RabbitMQ）、JDBC を選択して OK をクリックします。
4. Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
   • Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。

     cdata.jdbc.api.APIDriver

   • URL: JDBC URL を入力します。URL は jdbc:api: から始まり、その後に接続プロパティをセミコロン区切りで記述します。

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

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

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

   • User: 認証に使用するユーザー名です。通常は空白のままにします。
   • Password: 認証に使用するパスワードです。通常は空白のままにします。
   

5. Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

   

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

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

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

   

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

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

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

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

1. File メニューから New、Page Report と進んで新しいレポートを作成するか、既存のレポートの Chart Wizard を開きます。
2. Query を選択します（または新規作成します。上記を参照）。

3. クエリのカラムからチャートの Category と Value を設定し、Finish をクリックします。

4. レポートの View タブをクリックして、チャートを表示します。