Use Kafka with Ruby

Menu

There are many Kafka clients for Ruby, a list of some recommended options can be found here. In this example we’ll be using Zendesk’s ruby-kafka client.

Imports

Add the ruby-kafka package to your application, either by adding gem ‘ruby-kafka’ to your Gemfile or installing it manually with gem install ruby-kafka.

Using client ⇆ broker encryption (SSL)

If you have chosen to enable client ⇆ broker encryption, see here for information on the certificates required to establish an SSL connection to your cluster.

Producing Messages

Messages are produced to Kafka using a Kafka client Producer object. In this example we provide only the required properties for the Kafka client. See here for more details on configuration options.

Ensure the IP addresses, cluster certificate location and SCRAM password are correct. If your Kafka cluster does not have client ⇆ broker encryption enable, replace the ssl_ca_cert line with sasl_over_ssl: false.

Note: To connect to your Kafka cluster over the private network, use port 9093 instead of 9092.

Now that we have a Producer, sending a message is trivial:

Consuming Messages

Messages from Kafka are consumed using a Kafka client Consumer object. In this example we provide only the required properties for the Kafka client and consumer. See here for the full list of configuration options.

Ensure the IP addresses, cluster certificate location and SCRAM password are correct. If your Kafka cluster does not have client ⇆ broker encryption enable, replace the ssl_ca_cert line with sasl_over_ssl: false.

Note: To connect to your Kafka cluster over the private network, use port 9093 instead of 9092.

Before we can consume messages, we need to subscribe to the topics we wish to receive messages from:

Now we are ready to consume messages from Kafka. We use the consumer’s each_message method to output every consumed message:

Putting Them Together

Now that we have a consumer and producer setup, it’s time to combine them.

Start the consumer

Start the consumer before starting the producer because by default consumers only consume messages that were produced after the consumer started.

Start the producer

Now that the consumer is setup and ready to consume messages, you can now start your producer.

If the consumer and producer are setup correctly the consumer should output the message sent by the producer shortly after it was produced:

Site by Swell Design Group