Integrate RabbitMQ Data in the Pentaho Report Designer

The CData JDBC driver for RabbitMQ data enables access to live data from dashboards and reports. This article shows how to connect to RabbitMQ data as a JDBC data source and publish reports based on RabbitMQ data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new RabbitMQ connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:api: and is followed by a semicolon-separated list of connection 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.

     

     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:

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

   • Custom Driver Class Name: Enter cdata.jdbc.api.APIDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.
   

Add RabbitMQ Data to a Report

You are now ready to create a report with RabbitMQ data.

1. Add the RabbitMQ source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

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

   
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the AuthAttempts table.
4. Finally, run the report to see the chart.