Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document retry mechanic in a more detailed way #952

Open
mschwitalla opened this issue Jun 29, 2020 · 1 comment
Open

Document retry mechanic in a more detailed way #952

mschwitalla opened this issue Jun 29, 2020 · 1 comment

Comments

@mschwitalla
Copy link
Member

The retry mechanic of riptide is only briefly described in the documentation and could have more details to cover different questions.

Detailed Description

Especially the note that only idempotent requests are retried should be documented as this cost me quite some time to figure out. Additionally you could document that by default only connection errors are retried and otherwise you should define the retry behavior yourself. The riptide-failsaife documentation reads like the configuration of the retry behavior in the config would be good enough.

Context

It will prevent people from making mistakes that could be prevented with a couple of sentences in the documentation.

@fatroom
Copy link
Member

fatroom commented Jun 29, 2020

Idempotent requests behaviour clearly stated in readme: https://github.com/zalando/riptide/tree/master/riptide-failsafe#safe-and-idempotent-methods

Will add the notes about what actually retried as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants