Bridge RabbitMQ Connectivity with Apache NiFi

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData API Driver for JDBC, NiFi can work with live RabbitMQ data. This article describes how to connect to and query RabbitMQ data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live RabbitMQ data. When you issue complex SQL queries 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). Its built-in dynamic metadata querying allows you to work with and analyze RabbitMQ data using native data types.

Connecting to RabbitMQ Data in Apache NiFi

1. Download the CData API Driver for JDBC installer, unzip the package, run the .exe file to install the driver.

2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.api.jar (and cdata.jdbc.api.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

   On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData API Driver for JDBC.

3. Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.

   (OR)

   Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:

   cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
   .\run-nifi.bat
   

4. Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.

   Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.

5. When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.

   

   To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.

   
6. Right-click on the Nifi Flow's workspace and click "Controller Services"
7. Click the button to create a new controller service.
8. In the Controller Services section, location the newly created "DBCPConnection Pool" and click the menu () >> Edit to configure the new connection.

9. Fill in the properties:

   • Database Connection URL: jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
   • Database Driver Class Name: cdata.jdbc.api.APIDriver
   • Database Driver Location(s): Path to your Apache NiFi's lib folder where the JAR files are present.

   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.

   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
   
10. In the Controller Services section, locate the newly created DBCPConnection Pool and click the menu () >> Enable to enable the new connection.
11. In the "Enable Controller Service" window, set Scope to "Service and referencing components"
12. To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
13. Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
14. Double-click on the added processor (ExecuteSQL)to open the connection page.
15. In the Properties section, fill in the required information. Make sure to set the Database Connection Pooling Service to match the DBCPConnectionPool that you have created, and set your desired SQL query that you want to get executed in the SQL select query section.
16. Go to Relationships and make sure to select an option on how the component should proceed in case of success and failure of the execution process.
17. You can enable the ExecuteSQL component by either selecting it and clicking Enable on the Operation section, or by right-clicking it and selecting Enable.

Your RabbitMQ data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live RabbitMQ data in Apache NiFi. Reach out to our Support Team if you have any questions.