Connect to RabbitMQ Data in Jaspersoft Studio

This article shows how to connect to RabbitMQ from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for RabbitMQ. You will use the standard Jaspersoft wizards to build SQL queries to RabbitMQ. The queries are executed directly to the RabbitMQ APIs, enabling real-time connectivity to RabbitMQ data.

Connect to RabbitMQ Data as a JDBC Data Source

To create a JDBC data source in Jaspersoft Studio, create a data adapter:

1. In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
2. Select Database JDBC Connection.
3. Enter a user-friendly name for the driver.
4. On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
5. On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.api.APIDriver.
6. Enter the JDBC URL.

   About RabbitMQ Management HTTP API

   RabbitMQ is an open-source message broker that supports multiple messaging protocols. The RabbitMQ Management HTTP API provides HTTP-based access to management and monitoring data for a RabbitMQ server. The API exposes information about virtual hosts, exchanges, queues, bindings, connections, channels, consumers, users, permissions, policies, and cluster-wide statistics.

   The Management plugin must be enabled on the RabbitMQ server for the HTTP API to be available. By default, the management interface listens on port 15672.

   Using Basic Authentication

   RabbitMQ Management HTTP API uses HTTP Basic authentication. You must supply the username and password of a RabbitMQ management user.

   To enable access to the management API:

   1. Ensure the RabbitMQ Management plugin is enabled on your server (rabbitmq-plugins enable rabbitmq_management).
   2. Use an existing management user or create one with the appropriate management tag (management, policymaker, monitoring, or administrator).
   3. Note the full base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).

   After configuring your RabbitMQ server, set the following connection properties to connect:

   • AuthScheme: Set this to Basic.
   • URL: Set this to the base URL of your RabbitMQ Management HTTP API (e.g., http://localhost:15672).
   • User: Set this to your RabbitMQ management username (e.g., guest).
   • Password: Set this to your RabbitMQ management password.

   Example connection string:

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

   Available Tables

   The RabbitMQ profile provides access to the following tables:

   • Overview - Cluster-wide statistics and information about the RabbitMQ node
   • Nodes - Information about individual nodes in the RabbitMQ cluster
   • NodeMemory - Detailed memory usage breakdown for a specific cluster node
   • Connections - List of all open AMQP connections to the broker
   • Channels - List of all open AMQP channels across all connections
   • Consumers - List of all consumers registered across all queues
   • Exchanges - List of exchanges declared across all virtual hosts
   • Queues - List of queues declared across all virtual hosts
   • Bindings - List of all bindings between exchanges and queues
   • VirtualHosts - List of virtual hosts configured on the broker
   • VhostPermissions - User permissions within a specific virtual host
   • Users - List of all RabbitMQ users
   • Permissions - Permission records for all users across all virtual hosts
   • TopicPermissions - Topic-level permission records for all users
   • Policies - List of policies applied to queues and exchanges in virtual hosts
   • OperatorPolicies - List of operator policies applied to queues in virtual hosts
   • Parameters - List of component parameters (e.g., federation, shovel) per virtual host
   • GlobalParameters - List of global parameters that apply across all virtual hosts
   • VhostLimits - Resource limits configured for specific virtual hosts
   • UserLimits - Resource limits configured for specific users
   • FeatureFlags - List of feature flags and their enabled/disabled state on the node
   • DeprecatedFeatures - List of deprecated features and their usage state
   • AuthAttempts - Authentication attempt statistics for the node
   • ClusterName - The name of the RabbitMQ cluster
   • WhoAmI - Information about the currently authenticated management user
   • ExchangeBindingsSource - Bindings for which a specific exchange is the source
   • ExchangeBindingsDestination - Bindings for which a specific exchange is the destination
   • QueueBindings - Bindings for a specific queue within a virtual host

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the RabbitMQ JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   Below is a typical JDBC URL for RabbitMQ:

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

   👁 A data adapter configured to use the JDBC Driver. (Salesforce is shown.)
   

Create Reports with RabbitMQ Data

Follow the steps below to build an SQL query to RabbitMQ, the basis of a simple report:

1. Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
2. In the Data Adapter menu, select the data adapter you created in the previous section.
3. In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example:

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

   👁 The SQL query to be used to pull data into the report. (Salesforce is shown.)
   
4. Select the fields you want to include in the dataset. This example uses all fields.
5. Skip the Group By step and finish the wizard.

In the Preview tab, you can see the report as it would look with the current RabbitMQ data.

Create a Chart

The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.

Create a DataSet

Follow the steps below to create a new dataset to populate the chart:

1. In the report editing area, click the Design tab.
2. In the Outline view, right-click the root node for the report and click Create Dataset.
3. Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
4. In the Data Adapter menu, select the data adapter you created in the first section.
5. Enter a query such as the following:

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

   👁 The SQL query to be used to fill the chart. (Salesforce is shown.)
   
6. Select the fields you want in the dataset. This example uses and .
7. Skip the step to group by fields and finish the wizard.

Configure the Chart

After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:

1. Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
2. Drag a chart from the Palette onto the summary. The chart wizard is displayed.
3. Select the chart type. This example uses a bar chart.
4. In the Dataset menu, select the dataset you created for the chart.
5. In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
6. Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the column to set the expression to $F{}. 👁 The column selected as the Series for the chart.
   

7. Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click to set the expression to $F{}.

8. Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the column to set the expression to $F{}. If needed, convert the column type to string, as in the following expression:

   $F{}.toString()
   

   👁 Columns selected for the axes of the chart.
   
9. Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.

Running the Report

You can now generate reports on RabbitMQ data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.