Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Acking Framework Implementation
The tracking algorithm of acker is one of the major breakthroughs of Storm. JStorm extends it and makes some code optimization.
By the help of acker framework, the developer can well know the exact status of every single message that a spout has sent, either successful or failed. For instance, when integrated with the MetaQ or Kafka, if the message is successfully handled, the offset can be updated to the next, otherwise, resend this message. Therefore, it’s very easy to guarantee all the data will be handled without a miss via acker framework.
A failed tuple will not be resent automatically. It only triggers the “fail” logic of the spout, which needs to be implemented by the developer. By default, it will do nothing. You may need to implement the reload and send operation.
JStorm provide two interfaces to easily get tuple's value in ack or fail. So it is easily to resent data in fail, update Kafka/Rocket-MQ offset in ack operation.
In the acker framework, for each tuple a spout has sent:
- If the spout receives the response from the acker in the given time, we say this tuple is handled successfully
- If the spout hasn’t received the response till timeout, and the fail logic will be triggered, we say this tuple is failed.
- The fail response from the acker also means the fail of the tuple.
Additionally, ack framework can also be used to do flow control. Sometimes, the spout sending tuples' speed is faster than the bolt handling speed. To slow down the spout, we could control the number of max pending(no ack or fail response in time) tuples to make the spout not to execute nextTuple, when the actual number exceeds this configuration.
Set the max pending tuples of spout:
How to use the ack framework
- Append the msgId when emit the data in spout
- Set the number of acker over 0:
- Remember to ack the tuple in the bolt:
Bolt implements IRichBolt has to call the ack(
OutputCollector.ack(tuple)) or fail(
OutputCollector.fail(tuple)) method manually.
- Bolt implements IBasicBolt will ack automatically unless a FailedException is throwed.
- Bolt implements IRichBolt has to call the ack(
How to close the ack function
- No msgId when emitting data in the spout
- Set the number of acker as 0
Difference with Storm
- Only do one Map insert operation in acker to improve acker performance
- Spout guarantee Tuple's message rootId is unique to avoid missing track one tuple
- When the number of acker isn't 0, bolt should call Collector.ack(tuple) or Collector.fail(tuple) after execute one tuple. Because all metrics will be collected only when bolt execute Collector.ack or Collector.fail when acker isn't 0.
Please refer to Storm Acker