Skip to content

Commit

Permalink
add changelog warning about syncproducer config
Browse files Browse the repository at this point in the history 
Mitigation for the quasi-breaking change as noted in #816.
  • Loading branch information
@eapache
eapache authored Jan 26, 2017
1 parent 0fb560e commit 30a4aff
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

#### Version 1.11.0 (2016-12-20)

_Important:_ As of Sarama 1.11 it is necessary to set the config value of
`Producer.Return.Successes` to true in order to use the SyncProducer. Previous
versions would silently override this value when instantiating a SyncProducer
which led to unexpected values and data races.

New Features:
- Metrics! Thanks to Sébastien Launay for all his work on this feature
([#701](https://github.com/Shopify/sarama/pull/701),
Expand Down

3 comments on commit 30a4aff

@kchristidis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eapache Am I right to assume that even though Producer.Return.Successes should be set to true, a listening from the Successes() channel is not necessary? (As far I can tell, Successes() is not even part of the SyncProducer's interface.) If that's the case, I'm wondering whether such a clarification is necessary in the CHANGELOG as well.

@eapache
Copy link
Contributor Author

@eapache eapache commented on 30a4aff Mar 27, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kchristidis You are right, there is no Successes channel to listen on for the sync producer. Looking at this again it's actually even a bit more complicated (Producer.Return.Errors needs to be set as well). I'll open a ticket and put some notes there (edit: #854).

@kchristidis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, thank you for looking into it.

Please sign in to comment.