Skip to content

Commit 339e2c5

Browse files
committed
docs: clarify runtime defaults and dead-letter warning behavior
1 parent 20d6755 commit 339e2c5

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

docs/configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ hookrouter:
106106

107107
rate-limiter:
108108
enabled: true
109-
limit-for-period: 20
109+
limit-for-period: 20 # runtime default: 200
110110
limit-refresh-period: 1000
111111
timeout-duration: 0
112112

docs/dead-letter-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Notes:
1818
- `DeadLetterReprocessor` exists
1919
- `hookrouter.dead-letter.scheduler-enabled=true`
2020
- Reprocess marks an item `RESOLVED` only when replay delivery actually succeeds.
21+
- When `enabled=true` but no `DeadLetterStore` is configured, startup emits a warning and uses
22+
`LoggingDeadLetterHandler` (log-only mode).
2123

2224
## 2. Configuration keys
2325

docs/spring-boot-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,14 @@ public class DeadLetterConfig {
200200
```
201201

202202
Without a `DeadLetterStore` bean, `hookrouter` falls back to logging dead-letter events only.
203+
At startup, `hookrouter` logs a warning in this mode to highlight that persistence/replay is not active.
203204
For full usage patterns (manual replay, scheduler behavior, status lifecycle), see [`dead-letter-guide.md`](dead-letter-guide.md).
204205

205206
## 6. Recommended Production Baseline
206207

208+
Runtime defaults are intentionally safe for both local and production-like environments, but this section remains
209+
a stricter production baseline recommendation.
210+
207211
```yaml
208212
hookrouter:
209213
retry:
@@ -224,7 +228,7 @@ hookrouter:
224228
success-threshold: 3
225229
rate-limiter:
226230
enabled: true
227-
limit-for-period: 20
231+
limit-for-period: 20 # runtime default: 200
228232
limit-refresh-period: 1000
229233
timeout-duration: 0
230234
bulkhead:

0 commit comments

Comments
 (0)