Skip to content

Commit 76f17ba

Browse files
committed
docs: correct remaining stale 10s readiness bounds in README and example READMEs
1 parent caf54a9 commit 76f17ba

3 files changed

Lines changed: 10 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,10 @@ improperly prepared application.
100100

101101
After restore, the adapter also automatically refreshes its own HTTP connection
102102
to your application, so it never reuses a connection captured in the snapshot, and
103-
then re-runs the readiness check before admitting traffic. If the application does
104-
not report ready within 10 seconds of restore, the restore fails.
103+
then re-runs the readiness check before admitting traffic. By default this wait is
104+
unbounded; set `AWS_LWA_READINESS_CHECK_TIMEOUT_SECONDS` (fractional seconds allowed)
105+
to bound it, in which case a restore whose application does not report ready within
106+
that timeout fails.
105107

106108
> These hook paths are control-plane operations. External requests (via API
107109
> Gateway or ALB) that target a configured hook path receive `403 Forbidden` and

‎examples/fastapi-snapstart-zip/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To get more information of Wrapper script, please read Lambda documentation [her
2424
2. `AWS_LWA_SNAPSTART_AFTER_RESTORE_PATH` is set to `/snapstart/after`. The adapter sends an empty HTTP `POST` to this path over the refreshed connection. The app uses it to re-establish connections and regenerate per-environment unique values (in this example, it reconnects the pool and generates a fresh `connection_id`).
2525
3. It re-runs the readiness check against your app before admitting traffic.
2626

27-
Both hook routes must return a `2xx` status code. A non-2xx response, a connection failure, or taking longer than 60 seconds to respond fails the SnapStart phase. Likewise, if the readiness check does not pass within 10 seconds of restore, the restore fails — so traffic is never served against an app that has not finished recovering.
27+
Both hook routes must return a `2xx` status code. A non-2xx response, a connection failure, or taking longer than 60 seconds to respond fails the SnapStart phase. The readiness check runs on every restore; by default it waits indefinitely for the app to recover, but you can bound it with `AWS_LWA_READINESS_CHECK_TIMEOUT_SECONDS` (fractional seconds allowed), in which case a restore whose app does not report ready within that timeout fails — so traffic is never served against an app that has not finished recovering.
2828

2929
These hook routes are protected: the adapter only allows them to be invoked internally during the SnapStart lifecycle. External callers that request `/snapstart/before` or `/snapstart/after` receive a `403 Forbidden`.
3030

‎examples/fastapi-snapstart/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,11 @@ snapshot boundary:
5353

5454
Both hook routes must return a `2xx` status code. A non-2xx response, a connection
5555
failure, or taking longer than 60 seconds to respond fails the SnapStart phase.
56-
Likewise, if the readiness check does not pass within 10 seconds of restore, the
57-
restore fails — so traffic is never served against an app that has not finished
58-
recovering.
56+
The readiness check runs on every restore; by default it waits indefinitely for the
57+
app to recover, but you can bound it with `AWS_LWA_READINESS_CHECK_TIMEOUT_SECONDS`
58+
(fractional seconds allowed), in which case a restore whose app does not report
59+
ready within that timeout fails — so traffic is never served against an app that has
60+
not finished recovering.
5961

6062
These hook routes are protected: the adapter only allows them to be invoked internally
6163
during the SnapStart lifecycle. External callers that request `/snapstart/before` or

0 commit comments

Comments
 (0)