Build Visualizations of RabbitMQ Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData API Driver for JDBC, you can connect to live RabbitMQ data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to RabbitMQ using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live RabbitMQ data operations in Birst. When you issue complex SQL queries from Birst to RabbitMQ, the driver pushes supported SQL operations, like filters and aggregations, directly to RabbitMQ and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze RabbitMQ data using native Birst data types.

Configure a JDBC Connection to RabbitMQ Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst. 👁 Create a new Project in Birst
   
2. Name the connection (e.g. CDataAPI).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.
👁 Configure the Connection (part 1)

6. Set SQL Type to MSSQL
7. Set the Connection string.

   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 connection string for RabbitMQ:

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

8. Set the Driver Name: cdata.jdbc.api.APIDriver and click Save.

NOTE: Since authentication to RabbitMQ is managed from the connection string, you can leave Security Credentials blank.

Configure RabbitMQ Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. API).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.
👁 Select the Visualizer

2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData API Driver for JDBC with the Cloud Agent and Birst, you can easily create robust visualizations and reports on RabbitMQ data. Download a free, 30-day trial and start building Birst visualizations today.