You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: migrate module to github.com/IBM/sarama
- update declared module path and imports to github.com/IBM/sarama
- update URLs to issues/pull requests to use
https://github.com/IBM/sarama as well (as we don't know how long the
GitHub transparent redirects last for)
Signed-off-by: Dominic Evans <[email protected]>
Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apache.org/).
7
6
8
7
## Getting started
9
8
10
-
- API documentation and examples are available via [pkg.go.dev](https://pkg.go.dev/github.com/Shopify/sarama).
9
+
- API documentation and examples are available via [pkg.go.dev](https://pkg.go.dev/github.com/IBM/sarama).
11
10
- Mocks for testing are available in the [mocks](./mocks) subpackage.
12
11
- The [examples](./examples) directory contains more elaborate example applications.
13
12
- The [tools](./tools) directory contains command line tools that can be useful for testing, diagnostics, and instrumentation.
14
13
15
-
You might also want to look at the [Frequently Asked Questions](https://github.com/Shopify/sarama/wiki/Frequently-Asked-Questions).
14
+
You might also want to look at the [Frequently Asked Questions](https://github.com/IBM/sarama/wiki/Frequently-Asked-Questions).
16
15
17
16
## Compatibility and API stability
18
17
@@ -21,13 +20,13 @@ the two latest stable releases of Kafka and Go, and we provide a two month
21
20
grace period for older releases. However, older releases of Kafka are still likely to work.
22
21
23
22
Sarama follows semantic versioning and provides API stability via the gopkg.in service.
24
-
You can import a version with a guaranteed stable API via http://gopkg.in/Shopify/sarama.v1.
23
+
You can import a version with a guaranteed stable API via http://gopkg.in/IBM/sarama.v1.
25
24
A changelog is available [here](CHANGELOG.md).
26
25
27
26
## Contributing
28
27
29
-
- Get started by checking our [contribution guidelines](https://github.com/Shopify/sarama/blob/main/.github/CONTRIBUTING.md).
30
-
- Read the [Sarama wiki](https://github.com/Shopify/sarama/wiki) for more technical and design details.
28
+
- Get started by checking our [contribution guidelines](https://github.com/IBM/sarama/blob/main/.github/CONTRIBUTING.md).
29
+
- Read the [Sarama wiki](https://github.com/IBM/sarama/wiki) for more technical and design details.
31
30
- The [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol) contains a wealth of useful information.
32
31
- For more general issues, there is [a google group](https://groups.google.com/forum/#!forum/kafka-clients) for Kafka client developers.
This folder contains example applications to demonstrate the use of Sarama. For code snippet examples on how to use the different types in Sarama, see [Sarama's API documentation on pkg.go.dev](https://pkg.go.dev/github.com/Shopify/sarama)
4
-
5
-
In these examples, we use `github.com/Shopify/sarama` as import path. We do this to ensure all the examples are up to date with the latest changes in Sarama. For your own applications, you may want to use `gopkg.in/Shopify/sarama.v1` to lock into a stable API version.
3
+
This folder contains example applications to demonstrate the use of Sarama. For code snippet examples on how to use the different types in Sarama, see [Sarama's API documentation on pkg.go.dev](https://pkg.go.dev/github.com/IBM/sarama)
6
4
7
5
#### HTTP server
8
6
9
-
[http_server](./http_server) is a simple HTTP server uses both the sync producer to produce data as part of the request handling cycle, as well as the async producer to maintain an access log. It also uses the [mocks subpackage](https://pkg.go.dev/github.com/Shopify/sarama/mocks) to test both.
7
+
[http_server](./http_server) is a simple HTTP server uses both the sync producer to produce data as part of the request handling cycle, as well as the async producer to maintain an access log. It also uses the [mocks subpackage](https://pkg.go.dev/github.com/IBM/sarama/mocks) to test both.
10
8
11
9
#### Interceptors
12
10
13
11
Basic example to use a producer interceptor that produces [OpenTelemetry](https://github.com/open-telemetry/opentelemetry-go/) spans and add some headers for each intercepted message.
14
12
15
13
#### Transactional Producer
16
14
17
-
[txn_producer](./txn_producer) Basic example to use a transactional producer that produce on some topic within a Kafka transaction. To ensure transactional-id uniqueness it implement some ***ProducerProvider*** that build a producer appending an integer that grow when producer is created.
15
+
[txn_producer](./txn_producer) Basic example to use a transactional producer that produce on some topic within a Kafka transaction. To ensure transactional-id uniqueness it implement some **_ProducerProvider_** that build a producer appending an integer that grow when producer is created.
18
16
19
17
#### Exacly-once transactional paradigm
20
18
21
-
[exactly_once](./exactly_once) Basic example to use a transactional producer that produce consumed message from some topics within a Kafka transaction. To ensure transactional-id uniqueness it implement some ***ProducerProvider*** that build a producer using current message topic-partition.
19
+
[exactly_once](./exactly_once) Basic example to use a transactional producer that produce consumed message from some topics within a Kafka transaction. To ensure transactional-id uniqueness it implement some **_ProducerProvider_** that build a producer using current message topic-partition.
Copy file name to clipboardExpand all lines: mocks/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@ You can use them to test your sarama applications using dependency injection.
5
5
6
6
The following mock objects are available:
7
7
8
-
-[Consumer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#Consumer), which will create [PartitionConsumer](https://pkg.go.dev/github.com/Shopify/sarama/mocks#PartitionConsumer) mocks.
-[Consumer](https://pkg.go.dev/github.com/IBM/sarama/mocks#Consumer), which will create [PartitionConsumer](https://pkg.go.dev/github.com/IBM/sarama/mocks#PartitionConsumer) mocks.
0 commit comments