Connect to RabbitMQ in SpagoBI

The CData JDBC Driver for RabbitMQ enables you to connect to live RabbitMQ data from business intelligence and data mining tools that support the JDBC standard. This article shows how to integrate RabbitMQ data into a report in SpagoBI Studio and host it on SpagoBI Server.

• Deploy the Driver in SpagoBI Server
• Create a Report in SpagoBI Studio
• Host RabbitMQ Reports on SpagoBI Server

Deploy the JDBC Driver in SpagoBI Server

Follow the steps to create a JDBC data source for RabbitMQ in SpagoBI Server.

1. Copy the driver JAR into %CATALINA_BASE%/lib. These files are located in the lib subfolder of the installation directory.

2. Add a RabbitMQ driver resource to the context. The following resource definition can be added to the GlobalNamingResources element in server.xml:

   
   <Resource name="jdbc/api" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.api.APIDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. Add the following resource link to give access to Web applications. For this article, add the following line to META-INF\context.xml for SpagoBI.

   
   <ResourceLink global="jdbc/api" name="jdbc/api" type="javax.sql.DataSource"/>
   

4. Restart the server.

After adding the driver to the resources for the SpagoBI server, add the data source: In SpagoBI, click Resources -> Data Source -> Add and enter the following information:

• Label: Enter a unique identifier for the driver.
• Description: Enter a description for the driver.
• Dialect: Select Default Dialect.
• Read Only: Select the read-only option. This option determines whether the data source is the default database to save datasets created by the end user.
• Type: Select JDBC.
• URL: Enter the JDBC URL using the required connection string properties:

  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.

  

  A typical JDBC URL is below:

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

• Driver: Enter the class name for the driver: cdata.jdbc.api.APIDriver

Create Reports in SpagoBI Studio

Follow the steps below to populate reports based on RabbitMQ data in SpagoBI Studio. You will create a dataset that populates a chart with the results of an SQL query. In the next section, you will host this report on SpagoBI Server.

First, you will need to connect to RabbitMQ data from a report in SpagoBI Studio:

1. In SpagoBI Studio, click File -> New -> Project and select Report Project in the Business Intelligence and Reporting Tools folder.
2. Click File -> New -> Report and select Blank Report.
3. In the Data Explorer view, right-click Data Sources and click New Data Source.
4. Select JDBC Data Source and enter a name for the data source.
5. Click Manage Drivers and click Add to add the driver JAR, cdata.jdbc.api.jar. The driver JAR is located in the lib subfolder of the installation directory.
6. In the Driver Class menu, select the driver class, cdata.jdbc.api.APIDriver.
7. In the Database URL box, enter the JDBC URL. A typical JDBC URL is below:

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

   See the "Getting Started" chapter of the driver help for a guide to obtaining the required connection properties.

After you have connected to RabbitMQ data, create a dataset that contains the results of an SQL query:

1. Right-click the DataSet folder and click New Data Set. Select the JDBC data source for RabbitMQ and enter a name for the dataset.
2. Build the SQL query. In this example, this query will be used to add a chart to the dashboard. For example:

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

   

You can use the dataset to populate report objects. Follow the steps below to create a chart.

1. In the Palette view, drag a chart onto the canvas.
2. In the Select Chart Type tab, select a bar chart.
3. In the Select Data tab, click the Use Data From option and select the RabbitMQ data set from the menu.
4. Drag from the table to the series for the x-axis.
5. Drag from the table to the series for the y-axis.

Host RabbitMQ Reports on SpagoBI Server

Follow the steps below to host documents based on live RabbitMQ data on SpagoBI Server. You will use the report you created in the previous section as a template. To enable report users to access the live data, create placeholder parameters to be replaced by the RabbitMQ JDBC data source on the server:

1. If you have not already done so, open the Report Design perspective in SpagoBI Studio.
2. In the Data Explorer view, right-click the Report Parameters folder and click New Parameter. Add the url parameter and assign an empty value to it. This parameter is a placeholder for the JDBC data source on the SpagoBI Server.
3. Right-click the RabbitMQ data source and click Edit.

4. In the Property Binding node, set the JDBC Driver URL binding property to the url parameter: Click the box for the property. In the Category section, select Report Parameters. Select All in the Subcategory section and double-click the parameter.

   You can also enter the following in the JavaScript syntax:

   params["url"].value
   

   

Next, create a new document for the report on SpagoBI Server.

1. In SpagoBI Server, click Documents Development -> Create Document -> Generic Document. The Document Details page is displayed.
2. To create the document, enter the following:
   • Label: Enter a unique identifier for the document.
   • Name: Enter a user-friendly name for the document.
   • Type: Select Report from the menu.
   • Engine: Select BIRT Report Engine.
   • Data Source: Select the RabbitMQ Data Source you created in Create a JDBC Data Source for RabbitMQ in SpagoBI Server.
3. In the Show Document Templates section, select the folder where you want the document to be stored.

4. In the Template section, click Choose File. Navigate to the folder containing your report project. Select the .rptdesign file.

   Note: You can find the path to the project in the project properties.

5. Click the Save button.

When you run the report on the server, the placeholder url parameter is replaced with the JDBC URL defined on the server.