https://github.com/simpod/phpkafkabundle

Kafka bundle for Symfony
https://github.com/simpod/phpkafkabundle

kafka php rdkafka rdkafka-extension symfony symfony-bundle

Last synced: 9 days ago
JSON representation

Kafka bundle for Symfony

• Host: GitHub
• URL: https://github.com/simpod/phpkafkabundle
• Owner: simPod
• License: mit
• Created: 2018-01-30T14:45:01.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-14T18:07:13.000Z (about 1 month ago)
• Last Synced: 2024-12-15T04:07:43.030Z (13 days ago)
• Topics: kafka, php, rdkafka, rdkafka-extension, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 127 KB
• Stars: 8
• Watchers: 3
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# PHP Kafka Symfony bundle for php-rdkafka

[![GitHub Actions][GA Image]][GA Link]

[![Code Coverage][Coverage Image]][CodeCov Link]

[![Downloads][Downloads Image]][Packagist Link]

[![Packagist][Packagist Image]][Packagist Link]

[![Infection MSI][Infection Image]][Infection Link]

## Installation

Add as [Composer](https://getcomposer.org/) dependency:

```sh

composer require simpod/kafka-bundle

```

Then add `KafkaBundle` to Symfony's `bundles.php`:

```php

use SimPod\KafkaBundle\SimPodKafkaBundle;

return [

    ...

    new SimPodKafkaBundle()

    ...

];

```

## Usage

This package simply makes it easier to integrate https://github.com/arnaud-lb/php-rdkafka with Symfony. For more details how to work with Kafka in PHP, refer to its documentation.

### Available console commands:

- `bin/console debug:kafka:consumers` to list all available consumer groups

- `bin/console kafka:consumer:run ` to run consumer instance

### Config:

You can create eg. `kafka.yaml` file in your config directory with following content:

```yaml

kafka:

    authentication: '%env(KAFKA_AUTHENTICATION)%'

    bootstrap_servers: '%env(KAFKA_BOOTSTRAP_SERVERS)%'

    client:

        id: 'your-application-name'

```

- `authentication` reads env var `KAFKA_AUTHENTICATIOn` that contains authentication uri (`sasl-plain://user:password`, or it might be just empty indicating no authentication).

- `bootstrap_servers` reads env var `KAFKA_BOOTSTRAP_SERVERS` that contains comma-separated list of bootstrap servers (`broker-1.kafka:9092,broker-2.kafka:9092`).

If `bootstrap_servers` isn't set, it defaults to `127.0.0.1:9092`

### Services

Following services are registered in container and can be DI injected.

#### Configuration

class: `\SimPod\KafkaBundle\Kafka\Configuration`

Configuration service allows easy access to all the configuration properties.

```php

$config->set(ConsumerConfig::CLIENT_ID_CONFIG, $this->configuration->getIdWithHostname());

```

### Consuming

There's interface `NamedConsumer` available. When your consumer implements it, this bundle autoregisters it.

This is example of simple consumer, it can be then run via `bin/console kafka:consumer:run consumer1`

```php

configuration = $configuration;

    }

    public function run(): void

    {

        $kafkaConsumer = new KafkaConsumer($this->getConfig());

        $kafkaConsumer->subscribe(['topic1']);

        while (true) {

            ...

        }

    }

    

    public function getName(): string {

        return 'consumer1';    

    }

    private function getConfig(): ConsumerConfig

    {

        $config = new ConsumerConfig();

        $config->set(ConsumerConfig::BOOTSTRAP_SERVERS_CONFIG, $this->configuration->getBootstrapServers());

        $config->set(ConsumerConfig::ENABLE_AUTO_COMMIT_CONFIG, false);

        $config->set(ConsumerConfig::CLIENT_ID_CONFIG, $this->configuration->getClientIdWithHostname());

        $config->set(ConsumerConfig::AUTO_OFFSET_RESET_CONFIG, 'earliest');

        $config->set(ConsumerConfig::GROUP_ID_CONFIG, 'consumer_group');

        return $config;

    }

}

```

### Development

There is `kwn/php-rdkafka-stubs` listed as a dev dependency so it properly integrates php-rdkafka extension with IDE.

[GA Image]: https://github.com/simPod/PhpKafkaBundle/workflows/CI/badge.svg

[GA Link]: https://github.com/simPod/PhpKafkaBundle/actions?query=workflow%3A%22CI%22+branch%3Amaster

[Coverage Image]: https://codecov.io/gh/simPod/PhpKafkaBundle/branch/master/graph/badge.svg

[CodeCov Link]: https://codecov.io/gh/simPod/PhpKafkaBundle/branch/master

[Downloads Image]: https://poser.pugx.org/simpod/kafka-bundle/d/total.svg

[Packagist Image]: https://poser.pugx.org/simpod/kafka-bundle/v/stable.svg

[Packagist Link]: https://packagist.org/packages/simpod/kafka-bundle

[Infection Image]: https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2FsimPod%2FPhpKafkaBundle%2Fmaster

[Infection Link]: https://dashboard.stryker-mutator.io/reports/github.com/simPod/PhpKafkaBundle/master