logstash-plugins / logstash-output-http

Apache License 2.0
35 stars 82 forks source link

[Doc] clarify retry loop #130

Closed kaisecheng closed 2 years ago

kaisecheng commented 2 years ago

The retry policy confuses users mainly due to the unclear boundary of retry_failed and automatic_retries.

This PR explains retry_failed set to false does not affect the number of retries in lib level

karenzone commented 2 years ago

I left some comments wrt formatting.

Now

Here's how it renders now:

Screen Shot 2022-03-01 at 7 15 04 PM

Proposed

We can make it easier for users to scan and parse with some formatting tweaks (as suggested inline):

Screen Shot 2022-03-01 at 7 11 25 PM

Let me know what you think and if you would like to discuss. Thanks for your work on this.

karenzone commented 2 years ago

Also, what do you think about noting in option descriptions which retry type they apply to?

kaisecheng commented 2 years ago

Also, what do you think about noting in option descriptions which retry type they apply to?

If we have some markers to make it clear which options belong to which types, it would be very good. But now I only see verbose messages, so my new commits give a pointer (see Retry Policy...) to all four options. I hope these hints are clear enough.

kaisecheng commented 2 years ago

@karenzone Wow! The new format is so amazing! You raise it to the next level 🚀

Committed all your suggestion. I copy some important information from "Retry Policy" session to those four options, make a pointer from the options to the "Retry Policy", and update some wording. Please have a look to the last commit. Thank you.