Skip to content

Commit 1c2f9d8

Browse files
authored
Move http_client.retry_failed config inside retry_failed section
See issue #21434 Before: framework.http_client.max_retries After: framework.http_client.retry_failed.max_retries I am not sure if this is the proper way, as I did not see other sections in the framework config with this level of nesting.
1 parent d1f0ada commit 1c2f9d8

File tree

1 file changed

+74
-71
lines changed

1 file changed

+74
-71
lines changed

reference/configuration/framework.rst

Lines changed: 74 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1024,25 +1024,6 @@ The minimum version of TLS to accept. The value must be one of the
10241024

10251025
The ``crypto_method`` option was introduced in Symfony 6.3.
10261026

1027-
.. _reference-http-client-retry-delay:
1028-
1029-
delay
1030-
.....
1031-
1032-
**type**: ``integer`` **default**: ``1000``
1033-
1034-
The initial delay in milliseconds used to compute the waiting time between retries.
1035-
1036-
.. _reference-http-client-retry-enabled:
1037-
1038-
enabled
1039-
.......
1040-
1041-
**type**: ``boolean`` **default**: ``false``
1042-
1043-
Whether to enable the support for retry failed HTTP request or not.
1044-
This setting is automatically set to true when one of the child settings is configured.
1045-
10461027
extra
10471028
.....
10481029

@@ -1065,15 +1046,6 @@ headers
10651046
An associative array of the HTTP headers added before making the request. This
10661047
value must use the format ``['header-name' => 'value0, value1, ...']``.
10671048

1068-
.. _reference-http-client-retry-http-codes:
1069-
1070-
http_codes
1071-
..........
1072-
1073-
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1074-
1075-
The list of HTTP status codes that triggers a retry of the request.
1076-
10771049
http_version
10781050
............
10791051

@@ -1082,18 +1054,6 @@ http_version
10821054
The HTTP version to use, typically ``'1.1'`` or ``'2.0'``. Leave it to ``null``
10831055
to let Symfony select the best version automatically.
10841056

1085-
.. _reference-http-client-retry-jitter:
1086-
1087-
jitter
1088-
......
1089-
1090-
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1091-
1092-
This option adds some randomness to the delay. It's useful to avoid sending
1093-
multiple requests to the server at the exact same time. The randomness is
1094-
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1095-
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1096-
10971057
local_cert
10981058
..........
10991059

@@ -1111,16 +1071,6 @@ local_pk
11111071
The path of a file that contains the `PEM formatted`_ private key of the
11121072
certificate defined in the ``local_cert`` option.
11131073

1114-
.. _reference-http-client-retry-max-delay:
1115-
1116-
max_delay
1117-
.........
1118-
1119-
**type**: ``integer`` **default**: ``0``
1120-
1121-
The maximum amount of milliseconds initial to wait between retries.
1122-
Use ``0`` to not limit the duration.
1123-
11241074
max_duration
11251075
............
11261076

@@ -1149,26 +1099,6 @@ max_redirects
11491099
The maximum number of redirects to follow. Use ``0`` to not follow any
11501100
redirection.
11511101

1152-
.. _reference-http-client-retry-max-retries:
1153-
1154-
max_retries
1155-
...........
1156-
1157-
**type**: ``integer`` **default**: ``3``
1158-
1159-
The maximum number of retries for failing requests. When the maximum is reached,
1160-
the client returns the last received response.
1161-
1162-
.. _reference-http-client-retry-multiplier:
1163-
1164-
multiplier
1165-
..........
1166-
1167-
**type**: ``float`` **default**: ``2``
1168-
1169-
This value is multiplied to the delay each time a retry occurs, to distribute
1170-
retries in time instead of making all of them sequentially.
1171-
11721102
no_proxy
11731103
........
11741104

@@ -1239,6 +1169,7 @@ This option configures the behavior of the HTTP client when some request fails,
12391169
including which types of requests to retry and how many times. The behavior is
12401170
defined with the following options:
12411171

1172+
* :ref:`retry_strategy <reference-http-client-retry-retry-strategy>`
12421173
* :ref:`delay <reference-http-client-retry-delay>`
12431174
* :ref:`http_codes <reference-http-client-retry-http-codes>`
12441175
* :ref:`jitter <reference-http-client-retry-jitter>`
@@ -1272,8 +1203,20 @@ defined with the following options:
12721203
retry_failed:
12731204
max_retries: 4
12741205
1206+
.. _reference-http-client-retry-enabled:
1207+
1208+
enabled
1209+
"""""""
1210+
1211+
**type**: ``boolean`` **default**: ``false``
1212+
1213+
Whether to enable the support for retry failed HTTP request or not.
1214+
This setting is automatically set to true when one of the child settings is configured.
1215+
1216+
.. _reference-http-client-retry-retry-strategy:
1217+
12751218
retry_strategy
1276-
..............
1219+
""""""""""""""
12771220

12781221
**type**: ``string``
12791222

@@ -1284,6 +1227,66 @@ with ``http_codes``, ``delay``, ``max_delay``, ``multiplier`` and ``jitter``
12841227
options. This class has to implement
12851228
:class:`Symfony\\Component\\HttpClient\\Retry\\RetryStrategyInterface`.
12861229

1230+
.. _reference-http-client-retry-http-codes:
1231+
1232+
http_codes
1233+
""""""""""
1234+
1235+
**type**: ``array`` **default**: :method:`Symfony\\Component\\HttpClient\\Retry\\GenericRetryStrategy::DEFAULT_RETRY_STATUS_CODES`
1236+
1237+
The list of HTTP status codes that triggers a retry of the request.
1238+
1239+
.. _reference-http-client-retry-delay:
1240+
1241+
delay
1242+
"""""
1243+
1244+
**type**: ``integer`` **default**: ``1000``
1245+
1246+
The initial delay in milliseconds used to compute the waiting time between retries.
1247+
1248+
.. _reference-http-client-retry-jitter:
1249+
1250+
jitter
1251+
""""""
1252+
1253+
**type**: ``float`` **default**: ``0.1`` (must be between 0.0 and 1.0)
1254+
1255+
This option adds some randomness to the delay. It's useful to avoid sending
1256+
multiple requests to the server at the exact same time. The randomness is
1257+
calculated as ``delay * jitter``. For example: if delay is ``1000ms`` and jitter
1258+
is ``0.2``, the actual delay will be a number between ``800`` and ``1200`` (1000 +/- 20%).
1259+
1260+
.. _reference-http-client-retry-max-delay:
1261+
1262+
max_delay
1263+
"""""""""
1264+
1265+
**type**: ``integer`` **default**: ``0``
1266+
1267+
The maximum amount of milliseconds initial to wait between retries.
1268+
Use ``0`` to not limit the duration.
1269+
1270+
.. _reference-http-client-retry-max-retries:
1271+
1272+
max_retries
1273+
"""""""""""
1274+
1275+
**type**: ``integer`` **default**: ``3``
1276+
1277+
The maximum number of retries for failing requests. When the maximum is reached,
1278+
the client returns the last received response.
1279+
1280+
.. _reference-http-client-retry-multiplier:
1281+
1282+
multiplier
1283+
"""""""""
1284+
1285+
**type**: ``float`` **default**: ``2``
1286+
1287+
This value is multiplied to the delay each time a retry occurs, to distribute
1288+
retries in time instead of making all of them sequentially.
1289+
12871290
scope
12881291
.....
12891292

0 commit comments

Comments
 (0)