Skip to content

Commit 0e0fa2a

Browse files
authored
update doc (#283)
1 parent 3ec7710 commit 0e0fa2a

15 files changed

Lines changed: 665 additions & 610 deletions

docs/CHANGELOG.md

Lines changed: 32 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ All notable user-facing changes to this project are documented in this file.
1010

1111
## Release [3.4.0] 22-July-2025
1212
### Fixes
13-
* Fixed unique enqueue message to reject the message upfront instead of identifying it later #259
13+
* Improved unique message enqueuing to reject duplicates upfront rather than during
14+
processing. #259
1415

1516

1617
## Release [3.3.0] 29-June-2025
1718
### Fixes
18-
# Custom Message Converter was ignored #256
19-
# LockKey prefix was not used #239
19+
* Custom Message Converter was being ignored #256
20+
* LockKey prefix was not being used #239
2021

2122
## Release [3.2.0] 10-July-2024
2223
### Fixes
@@ -32,17 +33,17 @@ All notable user-facing changes to this project are documented in this file.
3233

3334
## Release [3.1.0] 24-June-2023
3435
{: .highlight }
35-
Migrate to this version to reduce redis resource utilization
36+
Migrate to this version to reduce Redis resource utilization.
3637

37-
This will fix an important bug happening due to task multiplications. This is causing more Redis
38-
resource usage Please check #[193]
38+
This release fixes a critical bug where task multiplication caused excessive Redis
39+
resource usage. For details, see issue #[193].
3940

4041
## Release [2.13.1] 24-June-2023
4142
{: .highlight }
42-
Migrate to this version to reduce redis resource utilization
43+
Migrate to this version to reduce Redis resource utilization.
4344

44-
This will fix an important bug happening due to task multiplications. This is causing more Redis
45-
resource usage Please check #[193]
45+
This release fixes a critical bug where task multiplication caused excessive Redis
46+
resource usage. For details, see issue #[193].
4647

4748

4849
## Release [3.0.1] 17-Jan-2022
@@ -51,15 +52,13 @@ We're so excited to release Rqueue `3.0.1`. This release supports the Java 17, S
5152
Spring Framework 6.x
5253

5354
### [2.13.0] - 25-Dec-2022
54-
5555
### Fixes
56-
5756
{: .highlight}
58-
Migrate to this version as soon as possible to avoid duplicate message consumption post deletion.
57+
Migrate to this version immediately to prevent duplicate message consumption after deletion.
5958

60-
* Important fix for parallel message deletion or delete the message from message listener
61-
* No threads are available, improvement on message poller
62-
* Use System Zone ID for UI bottom screen
59+
* Fixed an issue with parallel message deletion or deletion from within a message listener.
60+
* Improved message poller efficiency when no threads are available.
61+
* Corrected the UI to use the system's local time zone.
6362

6463
### [2.12.0] - 14-Dec-2022
6564

@@ -69,46 +68,40 @@ Migrate to this version as soon as possible to avoid duplicate message consumpti
6968
* Use System Zone ID for UI display
7069

7170
### [2.11.1] - 18-Nov-2022
72-
71+
### Fixes
7372
{: .highlight}
74-
Migrate to this version as soon as possible to avoid message build up. Messages in scheduled queue
75-
can grow if poller is failing. Workaround is to restart the application.
73+
Migrate to this version immediately to prevent scheduled message buildup. Messages could
74+
fail to be consumed if the poller encountered a Redis connection error.
7675

77-
* Message mover unreliability, scheduled message were not getting consumed once redis connection
78-
error occurs
79-
* Upgraded Jquery version
76+
* Improved reliability of the message mover during Redis connection errors.
77+
* Upgraded jQuery version.
8078

8179
### [2.10.2] - 16-Jul-2022
82-
8380
### Fixes
84-
85-
* Message status is not enqueued only, but it should be successful, failed etc
86-
* Weighted queue with size 1 was not working
87-
* Deleted message reappears
81+
* Fixed message status reporting (previously only showed 'enqueued').
82+
* Fixed an issue where weighted queues with size 1 were not working.
83+
* Fixed a bug where deleted messages could reappear.
8884

8985
### Features
90-
91-
* Disable Rqueue using `rqueue.enabled` flag
86+
* Added the `rqueue.enabled` flag to disable Rqueue if needed.
9287

9388
### [2.10.1] - 18-Oct-2021
9489

9590
* Fixes for concurrency when task executor is provided see issue #[122]
9691

9792
### [2.10.0] - 10-Oct-2021
98-
9993
{: .warning }
100-
Breaking change, if you're controlling any internal settings of Rqueue using application environment
101-
or configuration variable than application can break. We've renamed some config
102-
keys, [see](./migration#290-to-210)
94+
**Breaking Change**: Renamed several configuration keys. If you use custom Rqueue
95+
settings, please refer to the [Migration Guide](./migration#290-to-210) to avoid
96+
application failure.
10397

10498
### Fixes
105-
106-
* Fixes for post processor calls (post processor calls were not made)
107-
* Fixes message move message count (by default 1000 messages are moved)
108-
* Potential issue in rename collection
109-
* More than one (-) sign in the dashboard
110-
* Fixes for server context path. Rqueue end points would be served relative to
111-
x-forwarded-prefix/server.servlet.context-path
99+
* Fixed an issue where post-processor calls were not being triggered.
100+
* Corrected the default message move count in the dashboard to 1000.
101+
* Fixed a potential naming issue in `rename collection`.
102+
* Fixed a dashboard UI bug showing multiple minus signs.
103+
* Improved support for server context paths. Rqueue endpoints are now relative to the
104+
`x-forwarded-prefix` or `server.servlet.context-path`.
112105

113106
### Features
114107

docs/callback-and-events.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ description: Callbacks and Events in Rqueue
66
permalink: /callback-and-events
77
---
88

9-
Rqueue provides various types of callbacks and events for handling message processing and
10-
application events.
9+
Rqueue provides various callbacks and events to hook into message processing and
10+
application lifecycles.
1111

12-
## Message Processors/Callbacks
12+
## Message Processors and Callbacks
1313

14-
Rqueue supports the following message processors, which can be used for different purposes such as
15-
setting up tracers or managing transactions.
14+
Rqueue supports several message processors. These can be used for various purposes, such as
15+
setting up tracing contexts, managing transactions, or auditing.
1616

17-
### Pre Execution Processor
17+
### Pre-Execution Processor
1818

19-
This message processor is invoked before calling the handler methods. If the processor
20-
returns `false`, the message handler will not be called.
19+
The Pre-Execution Processor is invoked before a message handler is called. If the processor
20+
returns `false`, the handler execution is skipped.
2121

2222
```java
2323
class RqueueConfiguration {
@@ -36,9 +36,9 @@ class RqueueConfiguration {
3636
}
3737
```
3838

39-
### Discard Execution Processor
39+
### Discard Processor
4040

41-
This message processor is called whenever a message is discarded due to exceeding the retry limit.
41+
The Discard Processor is called when a message is discarded after exceeding its retry limit.
4242

4343
```java
4444
class RqueueConfiguration {
@@ -59,7 +59,7 @@ class RqueueConfiguration {
5959

6060
### Dead Letter Queue Processor
6161

62-
This message processor is called whenever a message is moved to the dead letter queue.
62+
This processor is invoked whenever a message is moved to a dead letter queue.
6363

6464
```java
6565
class RqueueConfiguration {
@@ -80,7 +80,7 @@ class RqueueConfiguration {
8080

8181
### Manual Deletion Processor
8282

83-
This message processor is called whenever a message is deleted manually.
83+
The Manual Deletion Processor is called whenever a message is manually deleted.
8484

8585
```java
8686
class RqueueConfiguration {
@@ -99,9 +99,9 @@ class RqueueConfiguration {
9999
}
100100
```
101101

102-
### Post Execution Processor
102+
### Post-Execution Processor
103103

104-
This message processor is called upon successful consumption of the message.
104+
This processor is called after a message has been successfully consumed.
105105

106106
```java
107107
class RqueueConfiguration {
@@ -122,16 +122,16 @@ class RqueueConfiguration {
122122

123123
## Events
124124

125-
Rqueue generates two types of application events: one for Rqueue container start/shutdown and
126-
another for task execution status.
125+
Rqueue generates two types of Spring Application Events: one for container lifecycle
126+
(start/shutdown) and another for job execution status.
127127

128-
### Job/Task Execution Event
128+
### Job/Task Execution Events
129129

130-
Upon completion of each task, Rqueue generates `RqueueExecutionEvent`, which the application can
131-
listen to. This event contains a job object providing all relevant information about the job.
130+
After a task completes, Rqueue publishes an `RqueueExecutionEvent`. Applications can listen
131+
for this event to get detailed information about job performance and outcomes.
132132

133-
### Application Bootstrap Event
133+
### Container Lifecycle Events
134134

135-
Once the RqueueListenerContainer is started, it emits `RqueueBootstrapEvent`. This event is
136-
generated post container shutdown and can be used for tasks such as queue registration or cleaning
137-
up local states.
135+
When the `RqueueListenerContainer` starts or stops, it publishes an `RqueueBootstrapEvent`.
136+
This event can be used to perform setup or cleanup operations when the messaging system
137+
initializes or shuts down.

0 commit comments

Comments
 (0)