8000 [HttpClient] add documentation for retry jitter by jderusse · Pull Request #14369 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[HttpClient] add documentation for retry jitter #14369 8000

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 7, 2020
Merged

[HttpClient] add documentation for retry jitter #14369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions reference/configuration/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ Configuration
* `max_delay`_
* `max_retries`_
* `multiplier`_
* `jitter`_

* `timeout`_
* `max_duration`_
Expand All @@ -164,6 +165,7 @@ Configuration
* `max_delay`_
* `max_retries`_
* `multiplier`_
* `jitter`_

* `http_method_override`_
* `ide`_
Expand Down Expand Up @@ -784,7 +786,8 @@ will automaticaly retry failed HTTP requests.
max_retries: 2
delay: 1000
multiplier: 3
max_delay: 500
max_delay: 5000
jitter: 0.3

scoped_clients:
my_api.client:
Expand Down Expand Up @@ -835,8 +838,8 @@ backoff_service
The service id used to compute the time to wait between retries. By default, it
uses an instance of
:class:`Symfony\\Component\\HttpClient\\Retry\\ExponentialBackOff` configured
with ``delay``, ``max_delay`` and ``multiplier`` options. This class has to
implement :class:`Symfony\\Component\\HttpClient\\Retry\\RetryBackOffInterface`.
with ``delay``, ``max_delay``, ``multiplier`` and ``jitter`` options. This
class has to implement :class:`Symfony\\Component\\HttpClient\\Retry\\RetryBackOffInterface`.

base_uri
........
Expand Down Expand Up @@ -969,6 +972,18 @@ http_version
The HTTP version to use, typically ``'1.1'`` or ``'2.0'``. Leave it to ``null``
to let Symfony select the best version automatically.

jitter
......

**type**: ``float`` **default**: ``0.1``

.. versionadded:: 5.2

The ``jitter`` option was introduced in Symfony 5.2.

The probability (expressed with a float between ``0.0`` and ``1.0``) of
randomness to apply to the delay to wait between retries.

local_cert
..........

Expand Down
0