From bec0a35da24d7f776542f0dd798d231d15c2dc16 Mon Sep 17 00:00:00 2001 From: Oliver Drotbohm Date: Fri, 13 Sep 2024 17:38:32 +0200 Subject: [PATCH] GH-818 - Fix reference docs on event republication on startup defaults. --- src/docs/antora/modules/ROOT/pages/appendix.adoc | 1 + src/docs/antora/modules/ROOT/pages/events.adoc | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/src/docs/antora/modules/ROOT/pages/appendix.adoc b/src/docs/antora/modules/ROOT/pages/appendix.adoc index 39dd221d..f91ef943 100644 --- a/src/docs/antora/modules/ROOT/pages/appendix.adoc +++ b/src/docs/antora/modules/ROOT/pages/appendix.adoc @@ -69,6 +69,7 @@ Can either be the class name of a custom implementation of `ApplicationModuleDet |`spring.modulith.republish-outstanding-events-on-restart` |`false` |Whether to republish outstanding event publications on restarts of the application. +Usually not recommended in multi-instance deployments as other instances might still be processing events. |=== [appendix] diff --git a/src/docs/antora/modules/ROOT/pages/events.adoc b/src/docs/antora/modules/ROOT/pages/events.adoc index c70ddce5..1ce438c0 100644 --- a/src/docs/antora/modules/ROOT/pages/events.adoc +++ b/src/docs/antora/modules/ROOT/pages/events.adoc @@ -204,7 +204,7 @@ image::event-publication-registry-start.png[] Each transactional event listener is wrapped into an aspect that marks that log entry as completed if the execution of the listener succeeds. In case the listener fails, the log entry stays untouched so that retry mechanisms can be deployed depending on the application's needs. -By default, all incomplete event publications are resubmitted at application startup. +Automatic re-publication of the events can be enabled via the xref:appendix.adoc#configuration-properties[`spring.modulith.republish-outstanding-events-on-restart`] property. .The transactional event listener arrangement after execution image::event-publication-registry-end.png[]