sarama README

The project's README from github.com/IBM/sarama. As one markdown file: README.md.

sarama

Go Reference OpenSSF Scorecard OpenSSF Best Practices

Sarama is an MIT-licensed Go client library for Apache Kafka.

Getting started

You might also want to look at the Frequently Asked Questions.

Compatibility and API stability

Sarama provides a "2 releases + 2 months" compatibility guarantee: we support the two latest stable releases of Kafka and Go, and we provide a two month grace period for older releases. However, older releases of Kafka are still likely to work.

Sarama follows semantic versioning and provides API stability via the standard Go module version numbering scheme.

A changelog is available here.

Contributing

sarama (IBM/sarama)

Searching Database…

12.5K ·GitHub
Что это такое?Sarama — это клиентская библиотека Go для Apache Kafka, которая позволяет Go-приложениям отправлять и получать сообщения Kafka.
Это самостоятельный инструмент или библиотека, которую я импортирую в свой Go-код?Это библиотека, которую вы импортируете в свое Go-приложение; она также включает пакеты-заглушки для тестирования и некоторые CLI-инструменты для диагностики.
Как добавить её в проект?Добавьте её как зависимость Go-модуля и посмотрите документацию API и примеры на pkg.go.dev или в каталоге examples, чтобы увидеть типичные способы использования.
Нужна ли определённая версия Kafka или Go?Нужен достаточно свежий брокер Kafka и инструментарий Go; Sarama поддерживает совместимость по принципу «2 релиза + 2 месяца» для обоих.
Будут ли работать старые версии Kafka?Официально это не гарантируется, но, скорее всего, они будут работать нормально.
Где найти реальные примеры использования?В каталоге examples репозитория находятся более развёрнутые примеры приложений, которые показывают, как на практике использовать Sarama.
Можно ли писать тесты для кода, использующего Sarama, без реального брокера Kafka?Да, Sarama включает подпакет mocks, специально созданный для тестирования кода на поддельных ответах Kafka.
Где более подробная техническая документация?В вики Sarama описаны более подробные технические детали и принципы устройства, а для понимания на уровне протокола указана спецификация протокола Kafka.
What are similar projects?redpanda, picomq, kafgres, architect-awesome, encore, iii, kafka-ui, emqx
Creator
IBM
Size
12.5 MB
Stars
12.5K
Age
13y
Commits · 90 Days