Skip to main content

Configuration reference

All outbox properties use the prefix jeap.messaging.transactional-outbox. They are bound to TransactionalOutboxConfigurationProperties. Every property has a default, so the outbox works with no configuration. Durations use ISO-8601 (PT15S, P2D) or Spring duration syntax.

jeap:
messaging:
transactional-outbox:
message-send-immediately-timeout: 15s
scheduled-relay-enabled: true
sent-message-retention-duration: P2D

Delivery (immediate)

PropertyDefaultTypeDescription
message-send-immediately-timeoutPT15SDurationMax time to wait for Kafka to finish sending when sending immediately after commit. Keep small so the request thread is not held too long if Kafka is slow
message-send-immediately-max-block-timePT5SDurationMax time to wait for Kafka to start sending (producer max.block.ms) for immediate sends. Keep small

Delivery (scheduled / relay)

PropertyDefaultTypeDescription
message-send-scheduled-timeoutPT60SDurationMax time to wait for Kafka to finish sending in the relay. Choose large enough to relay even when Kafka is slow
message-send-scheduled-max-block-timePT15SDurationMax time to wait for Kafka to start sending (producer max.block.ms) in the relay
scheduled-relay-enabledtruebooleanEnable the background relay process. Disable to run dedicated relay instances elsewhere
poll-delayPT2SDurationDelay between relay polls (also used as the scheduler fixed delay and the relay backoff)
continuous-relay-timeoutPT5MDurationMax time the relay keeps sending without interruption before yielding. Bounds how long it holds the relay lock
message-relay-batch-size5intMax number of messages the relay reads and sends per batch

Housekeeping & retention

PropertyDefaultTypeDescription
house-keeping-schedule0 0 3 * * *CronCron expression for when the cleanup job runs
house-keeping-page-size500intPage size for housekeeping delete queries
house-keeping-max-pages100000intMax pages per run (page-size * max-pages = max deletes per kind per run)
sent-message-retention-durationP2DDurationHow long successfully sent messages are kept before deletion
unsent-message-retention-durationP30DDurationHow long not-yet-sent messages are kept before deletion

Metrics

PropertyDefaultTypeDescription
metrics-update-intervalPT10SDurationInterval between metrics-gauge updates