Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deadletter documentation added #281

Merged
merged 36 commits into from
Sep 9, 2022
Merged

Deadletter documentation added #281

merged 36 commits into from
Sep 9, 2022

Conversation

YvonneCeelie
Copy link
Contributor

@YvonneCeelie YvonneCeelie commented Aug 29, 2022

Added deadletter queue, see AxonFramework/AxonFramework#2021

@gklijs
Copy link
Contributor

gklijs commented Aug 29, 2022

I think it needs to go to the 4.6.0 branch instead of master.

@YvonneCeelie YvonneCeelie changed the base branch from master to 4.6 August 30, 2022 07:26
Copy link
Contributor

@gklijs gklijs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Loog good to me 👍

smcvb
smcvb previously requested changes Sep 1, 2022
Copy link
Collaborator

@smcvb smcvb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main line is clear and fine, so thanks for that.
I do have a bunch of suggestions that hopefully improve the completeness of this section for our users. Let me know what you think!

axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
YvonneCeelie and others added 8 commits September 5, 2022 10:40
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
Co-authored-by: Steven van Beelen <steven.vanbeelen@axoniq.io>
@smcvb smcvb self-requested a review September 9, 2022 11:51
Strengthen point that the in-memory DLQ is not production ready

#281
@smcvb smcvb dismissed their stale review September 9, 2022 12:11

Processed all comments myself. Hence I do not apply as a reviewer anymore.

@smcvb smcvb removed their request for review September 9, 2022 12:11
Copy link
Contributor

@CodeDrivenMitch CodeDrivenMitch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some improvements need to be made, other than that I think the content looks great.

axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
axon-framework/events/event-processors/README.md Outdated Show resolved Hide resolved
smcvb and others added 12 commits September 9, 2022 15:34
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Co-authored-by: Mitchell Herrijgers <mitchellherrijgers@gmail.com>
Process review comments by adjusting and further fine-tuning description
 of:
 - the importance of sequencing dead letter,
 - where to find the SequencedDeadLetterProcessor,
 - the description of the message attribute,
 - the enqueue decision intro description,
 - a better example on diagnostics usage.

#281
@smcvb smcvb merged commit c724a38 into 4.6 Sep 9, 2022
@smcvb smcvb deleted the deadletter branch September 9, 2022 13:46
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ intro section by:
 * adding a small introduction,
 * replacing event processor mentions for processing group,
 * add details on maintaining a dead letter sequence

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ configuration section by:
 * adjusting the indentation,
 * slightly adjusting the samples,
 * replacing mentions of event processor with processing group

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ processing section by:
 * expanding the intro section by explaining the
 SequencedDeadLetterProcessor and its methods,
 * adjust the sample titles
 * adjusting the indentation,
 * replacing repair for retry in the samples as there is no guarantee
 the letter is not enqueued again,
 * replacing mentions of event processor with processing group

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ attributes section by:
 * fix the section title,
 * use code sections,
 * remove markTouched, withCause and withDiagnostics,
 * change message type to EventMessage
 * change cause type to Optional<Cause>,
 * explain why the cause may be empty,
 * explain that diagnostics are filled through an EnqueuePolicy

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ policy section by:
 * introduce desire to not enqueue at all times,
 * introduce EnqueuePolicy and EnqueueDecision,
 * explain when the policy kicks in,
 * explain scenario when to configure a custom policy,
 * separate the policy creation and configuration into two sample
 sections
 * use several Decisions operations to showcase it.

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Adjust DLQ idempotency section by:
 * moving it to right after the intro section,
 * making it a separate subsection for clarity,
 * expanding on why this is strongly recommended

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Strengthen point that the in-memory DLQ is not production ready

#281
smcvb added a commit that referenced this pull request Sep 13, 2022
Process review comments by adjusting and further fine-tuning description
 of:
 - the importance of sequencing dead letter,
 - where to find the SequencedDeadLetterProcessor,
 - the description of the message attribute,
 - the enqueue decision intro description,
 - a better example on diagnostics usage.

#281
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants