Guides > Databases > Kafka > Php

This guide will walk you through the process of connecting to Kafka using PHP within your Sealos DevBox project.

Prerequisites

A Sealos DevBox project with PHP environment
A Kafka cluster created using the Database app in Sealos

Install Required Extensions

In your Cursor terminal, first install the necessary system dependencies:

sudo apt-get update
sudo apt-get install -y librdkafka-dev

Then, install the Kafka extension for PHP:

sudo pecl install rdkafka
sudo sh -c 'echo "extension=rdkafka.so" > /etc/php/*/mods-available/rdkafka.ini'
sudo phpenmod rdkafka

Connection Setup

Create a Configuration File

First, let's create a configuration file to store our Kafka connection parameters. Create a file named config.php in your project directory with the following content:

<?php
return [
    'brokers' => 'your_kafka_broker:9092',
    'topic' => 'your_topic_name',
    'group_id' => 'your_consumer_group_id'
];

Replace the placeholders with your actual Kafka credentials from the Database app in Sealos.

Create a Kafka Producer

Create a file named kafka_producer.php with the following content:

<?php
$config = include 'config.php';
 
$conf = new RdKafka\Conf();
$conf->set('metadata.broker.list', $config['brokers']);
 
$producer = new RdKafka\Producer($conf);
 
$topic = $producer->newTopic($config['topic']);
 
$message = "Hello from Sealos DevBox!";
$topic->produce(RD_KAFKA_PARTITION_UA, 0, $message);
 
$producer->flush(10000);
 
echo "Message sent: $message\n";

This script creates a Kafka producer and sends a message to the specified topic.

Create a Kafka Consumer

Create another file named kafka_consumer.php with the following content:

<?php
$config = include 'config.php';
 
$conf = new RdKafka\Conf();
$conf->set('group.id', $config['group_id']);
$conf->set('metadata.broker.list', $config['brokers']);
$conf->set('auto.offset.reset', 'earliest');
 
$consumer = new RdKafka\KafkaConsumer($conf);
$consumer->subscribe([$config['topic']]);
 
echo "Waiting for messages...\n";
 
while (true) {
    $message = $consumer->consume(120*1000);
    switch ($message->err) {
        case RD_KAFKA_RESP_ERR_NO_ERROR:
            echo "Received message: " . $message->payload . "\n";
            break;
        case RD_KAFKA_RESP_ERR__PARTITION_EOF:
            echo "No more messages; will wait for more\n";
            break;
        case RD_KAFKA_RESP_ERR__TIMED_OUT:
            echo "Timed out\n";
            break;
        default:
            throw new \Exception($message->errstr(), $message->err);
            break;
    }
}

This script creates a Kafka consumer that listens for messages on the specified topic.

Usage

To run the producer script, use the following command in your Cursor terminal:

php kafka_producer.php

To run the consumer script, open another terminal and use:

php kafka_consumer.php

The consumer will start listening for messages. When you run the producer script, you should see the message being received by the consumer.

Best Practices

Use environment variables for Kafka configuration details.
Implement proper error handling and logging.
Consider using a library like monolog for better logging capabilities.
Implement a graceful shutdown mechanism for your consumer.
Use compression for better performance when dealing with large messages or high throughput.

Troubleshooting

If you encounter connection issues:

Verify your Kafka broker address in the config.php file.
Ensure your Kafka cluster is running and accessible.
Check for any network restrictions in your DevBox environment.
Confirm that the rdkafka extension is correctly installed and enabled.

For more detailed information on using Kafka with PHP, refer to the php-rdkafka documentation.

PHP

On this page