IBM MQ Sink Connector for Confluent Platform
The Kafka Connect IBM MQ Sink Connector is used to move messages from Kafka to
an IBM MQ cluster.
The IBM MQ Sink Connector includes the following features:
At least once delivery
This connector guarantees that records are delivered at least once from the Kafka
The following are required to run the Kafka Connect IBM MQ Sink Connector:
- Kafka Broker: Confluent Platform 3.3.0 or above, or Kafka 0.11.0 or above
- Kafka Connect: Confluent Platform 4.1.0 or above, or Kafka 1.1.0 or above (requires header support in Connect)
- IBM MQ 8.0.0
or above, or IBM MQ on Cloud service
- IBM MQ Client Jar (See Client Jars section)
- Java 1.8
Install IBM MQ Sink Connector
You can install this connector by using the Confluent Hub client installation
instructions or by
manually downloading the ZIP file.
You must install the connector on every machine where Connect will run.
An install of the Confluent Hub Client.
This is installed by default with Confluent Enterprise.
An install of the latest (
latest) connector version.
To install the
latest connector version, navigate to your Confluent Platform
installation directory and run the following command:
confluent-hub install confluentinc/kafka-connect-ibmmq-sink:latest
You can install a specific version by replacing
latest with a version
number as shown in the following example:
confluent-hub install confluentinc/kafka-connect-ibmmq-sink:1.0.0-preview
This connector does not include the IBM MQ client JAR. See the
IBM MQ Client Library section for more details.
IBM MQ Client Library
The Kafka Connect IBM MQ connector does not come with the IBM MQ client
If you are running a multi-node Connect cluster, the IBM MQ connector and IBM
MQ client JAR must be installed on every Connect worker in the cluster.
See below for details.
Installing IBM MQ Client Library
This connector relies on a provided
com.ibm.mq.allclient client JAR
distributed by IBM. The connector will not run if you have not installed the
JAR on each Connect worker node.
The installation steps are:
- Follow IBM’s guide on Obtaining the IBM MQ classes for JMS separately
to download the IBM MQ client JAR. #. The installation should have created a
wmq/JavaSE directory. From this directory, copy only the
com.ibm.mq.allclient.jar file into the
share/java/kafka-connect-ibmmq-sink directory of your Confluent Platform installation on
each worker node.
- Restart all of the Connect worker nodes.
share/java/kafka-connect-ibmmq-sink directory mentioned above is for
Confluent Platform. If you are using a different installation, find the location of the
Confluent IBM MQ sink connector JAR files and place the IBM MQ client JAR
file into the same directory.
JMS Message Formats
The format of outgoing JMS Message values is configured with the
jms.message.format property, using one of the following options:
When using the
string Message Format, record values are run through
Values.convertToString(...) from the Connect Data package and produced as a
Primitive values are converted to their String equivalent and structured objects
are transformed to a sensible string representation that is similar to the JSON
representation, with the exception of simple string values (not in objects or
arrays) which are unquoted.
Single Message Transformation can
be used with the configured
jms.message.format to transform the record
value to the desired string representation before the connector processes
Record values are serialized without the Avro schema information and produced as
BytesMessage. JMS consumers must have the schema to deserialize
The connector attempts to infer the Avro schema for records that have no
schema. If the connector cannot infer the schema, the task is killed. If you
are processing data without a schema, consider using one of the other
Record values are converted to a UTF-8 encoded JSON representation and produced
as a JMS
Record values are passed along in bytes form without any conversion.
Record values must be converted to bytes form before the connector processes
them. Configure the
value.converter property to
org.apache.kafka.connect.converters.ByteArrayConverter to ensure that
record values arrive in byte format.
Forwarding Kafka Properties to JMS
The connector can be configured to forward various values from the Kafka record
to the JMS Message.
jms.forward.kafka.key to convert the record’s key to a String and
forward it as the
jms.forward.kafka.metadata to forward the record’s topic,
partition, and offset on JMS Message properties.
- Kafka topic is applied to the message as a String property named
- Partition is applied to the message as an Int property named
- Offset is applied to the message as a Long property named
jms.forward.kafka.headers to add each header from the SinkRecord to
the JMS Message as a String property.
The connector converts the record key and headers to a sensible string
representation that is similar to the JSON representation, with the
exception of simple string values (not in objects or arrays) which are
unquoted. No other conversion is done to the key and headers before
forwarding them on the JMS Message. If another format is needed,
out-of-the-box or custom Single Message
Transformation can be used with the connector
to transform the record keys and/or headers to the desired string
representation before the JMS sink connector processes each record.
This quick start uses the IBM MQ Sink Connector to consume records from Kafka and
send them to an IBM MQ broker running in a Docker container.
Start the IBM MQ broker.
docker run -d \
-p 1414:1414 -p 9443:9443 \
-e LICENSE=accept \
Install the connector through the Confluent Hub Client.
# run from your Confluent Platform installation directory
confluent-hub install confluentinc/kafka-connect-ibmmq-sink:latest
Start Confluent Platform.
The command syntax for the Confluent CLI development commands changed in 5.3.0.
These commands have been moved to
confluent local. For example, the syntax for
confluent start is now
confluent local services start. For more information, see confluent local.
confluent local services start
test data to the
sink-messages topic in Kafka.
seq 10 | confluent local services kafka produce sink-messages
ibmmq-sink.json file with the following contents:
Load the IBM MQ Sink Connector.
You must include a double dash (
--) between the topic name and your flag. For more information,
see this post.
confluent local services connect connector load mq --config ibmmq-sink.json
Don’t use the Confluent CLI in production
Confirm that the connector is in a
confluent local services connect connector status mq
Navigate to the IBM MQ Console to
confirm the messages were delivered to the
The default credentials for the IBM MQ Console are