Build Charts with RabbitMQ Data in Clear Analytics

The CData ODBC driver for RabbitMQ enables access to live data from RabbitMQ under the ODBC standard, allowing you work with RabbitMQ data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to RabbitMQ as an ODBC source and create queries, tables, and charts (including PivotTables) based on RabbitMQ data.

Connect to RabbitMQ Data

Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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

When you configure the DSN, 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.

Configure the Data Source in Clear Analytics

1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
2. Select Database as the data source.
3. In the Set Connection section, click the option to create a new database.
4. Select Microsoft ODBC Data Source as the data source and click OK.
5. Select the DSN you already configured from the drop-down menu.
6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
10. In the Domain Relations section, add any relational information between tables.
11. In the Domain Tree section, create groups for your data and add the available items to the groups.
12. Review the summary of your data and click Finish.

Create a Chart with RabbitMQ Data

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

Create a New Query

1. Click Repository in the CLEAR ANALYTICS ribbon.
2. Create a new query.
3. Select the columns you wish to retrieve.
4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
5. Set filters and formulas by dragging columns to the lower window.
6. Name your query and click Save.

Build a Chart Based on a Query Report

With the query created, you are now ready to execute a report and display a chart.

1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
3. Select the query you just created.
4. Name the report and click 'Save and Execute'.
5. Click the Results tab within the Report Explorer
6. Expand your report and drag the chart to the Excel spreadsheet.
7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of RabbitMQ data. With the ODBC Driver for RabbitMQ and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from RabbitMQ.