Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,359 Commits
.github		.github
examples		examples
internal/toxiproxy		internal/toxiproxy
mocks		mocks
tools		tools
.gitignore		.gitignore
.golangci.yml		.golangci.yml
.pre-commit-config.yaml		.pre-commit-config.yaml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile.kafka		Dockerfile.kafka
LICENSE.md		LICENSE.md
Makefile		Makefile
README.md		README.md
SECURITY.md		SECURITY.md
Vagrantfile		Vagrantfile
acl_bindings.go		acl_bindings.go
acl_create_request.go		acl_create_request.go
acl_create_request_test.go		acl_create_request_test.go
acl_create_response.go		acl_create_response.go
acl_create_response_test.go		acl_create_response_test.go
acl_delete_request.go		acl_delete_request.go
acl_delete_request_test.go		acl_delete_request_test.go
acl_delete_response.go		acl_delete_response.go
acl_delete_response_test.go		acl_delete_response_test.go
acl_describe_request.go		acl_describe_request.go
acl_describe_request_test.go		acl_describe_request_test.go
acl_describe_response.go		acl_describe_response.go
acl_describe_response_test.go		acl_describe_response_test.go
acl_filter.go		acl_filter.go
acl_types.go		acl_types.go
acl_types_test.go		acl_types_test.go
add_offsets_to_txn_request.go		add_offsets_to_txn_request.go
add_offsets_to_txn_request_test.go		add_offsets_to_txn_request_test.go
add_offsets_to_txn_response.go		add_offsets_to_txn_response.go
add_offsets_to_txn_response_test.go		add_offsets_to_txn_response_test.go
add_partitions_to_txn_request.go		add_partitions_to_txn_request.go
add_partitions_to_txn_request_test.go		add_partitions_to_txn_request_test.go
add_partitions_to_txn_response.go		add_partitions_to_txn_response.go
add_partitions_to_txn_response_test.go		add_partitions_to_txn_response_test.go
admin.go		admin.go
admin_test.go		admin_test.go
alter_client_quotas_request.go		alter_client_quotas_request.go
alter_client_quotas_request_test.go		alter_client_quotas_request_test.go
alter_client_quotas_response.go		alter_client_quotas_response.go
alter_client_quotas_response_test.go		alter_client_quotas_response_test.go
alter_configs_request.go		alter_configs_request.go
alter_configs_request_test.go		alter_configs_request_test.go
alter_configs_response.go		alter_configs_response.go
alter_configs_response_test.go		alter_configs_response_test.go
alter_partition_reassignments_request.go		alter_partition_reassignments_request.go
alter_partition_reassignments_request_test.go		alter_partition_reassignments_request_test.go
alter_partition_reassignments_response.go		alter_partition_reassignments_response.go
alter_partition_reassignments_response_test.go		alter_partition_reassignments_response_test.go
alter_user_scram_credentials_request.go		alter_user_scram_credentials_request.go
alter_user_scram_credentials_request_test.go		alter_user_scram_credentials_request_test.go
alter_user_scram_credentials_response.go		alter_user_scram_credentials_response.go
alter_user_scram_credentials_response_test.go		alter_user_scram_credentials_response_test.go
api_versions_request.go		api_versions_request.go
api_versions_request_test.go		api_versions_request_test.go
api_versions_response.go		api_versions_response.go
api_versions_response_test.go		api_versions_response_test.go
async_producer.go		async_producer.go
async_producer_test.go		async_producer_test.go
balance_strategy.go		balance_strategy.go
balance_strategy_test.go		balance_strategy_test.go
broker.go		broker.go
broker_test.go		broker_test.go
client.go		client.go
client_test.go		client_test.go
client_tls_test.go		client_tls_test.go
compress.go		compress.go
config.go		config.go
config_resource_type.go		config_resource_type.go
config_test.go		config_test.go
consumer.go		consumer.go
consumer_group.go		consumer_group.go
consumer_group_example_test.go		consumer_group_example_test.go
consumer_group_members.go		consumer_group_members.go
consumer_group_members_test.go		consumer_group_members_test.go
consumer_group_test.go		consumer_group_test.go
consumer_metadata_request.go		consumer_metadata_request.go
consumer_metadata_request_test.go		consumer_metadata_request_test.go
consumer_metadata_response.go		consumer_metadata_response.go
consumer_metadata_response_test.go		consumer_metadata_response_test.go
consumer_test.go		consumer_test.go
control_record.go		control_record.go
control_record_test.go		control_record_test.go
crc32_field.go		crc32_field.go
create_partitions_request.go		create_partitions_request.go
create_partitions_request_test.go		create_partitions_request_test.go
create_partitions_response.go		create_partitions_response.go
create_partitions_response_test.go		create_partitions_response_test.go
create_topics_request.go		create_topics_request.go
create_topics_request_test.go		create_topics_request_test.go
create_topics_response.go		create_topics_response.go
create_topics_response_test.go		create_topics_response_test.go
decompress.go		decompress.go
delete_groups_request.go		delete_groups_request.go

Repository files navigation

sarama

Sarama is an MIT-licensed Go client library forApache Kafka.

Getting started

API documentation and examples are available viapkg.go.dev.
Mocks for testing are available in themocks subpackage.
Theexamples directory contains more elaborate example applications.
Thetools directory contains command line tools that can be useful for testing, diagnostics, and instrumentation.

You might also want to look at theFrequently Asked Questions.

Compatibility and API stability

Sarama provides a "2 releases + 2 months" compatibility guarantee: we supportthe two latest stable releases of Kafka and Go, and we provide a two monthgrace 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 Gomodule version numbering scheme.

A changelog is availablehere.