Skip to content

Commit ed6e6cc

Browse files
Update 'load' parameter details in documentation (#433)
Clarified the 'load' parameter description and added a detailed explanation with an example scenario for better understanding.
1 parent c3a37e0 commit ed6e6cc

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/configure-event/index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ they should be processed.
4646
| type | Specifies the type of the event. | - |
4747
| subType | Specifies the subtype of the event, further categorizing the event type. | - |
4848
| namespace | Default namespace in which event is published | default |
49-
| load | Indicates the load of the event, affecting the processing concurrency. | 1 |
49+
| load | Number between 1 and 100 indicating the [load](#load) of the event, affecting the processing concurrency. | 1 |
5050
| retryAttempts | Number of retry attempts for failed events. Set to `-1` for infinite retries. | 3 |
5151
| processAfterCommit | Indicates whether an event is processed immediately after the transaction, in which the event was written, has been committed. | true |
5252
| propagateHeaders | Specifies which headers from the original CDS context should be forwarded to the queue call. Provide an array of header names to propagate. | [] |
@@ -427,6 +427,20 @@ adjustment is made for event types in the queue for more than three minutes. The
427427
remains in the queue for more than three minutes, its priority is temporarily bumped up by one level (i.e., from Low to
428428
Medium).
429429

430+
# Load
431+
432+
The `load` parameter serves the function of regulating the number of concurrent processes permitted per app-instance. The maximum load for each app-instance is 100.
433+
434+
Consider the following scenario:
435+
436+
There are three events (irrespective of whether they are periodic or ad-hoc events).
437+
438+
- Event A has a specified load of 40.
439+
- Event B has a specified load of 50.
440+
- Event C has a specified load of 20.
441+
442+
At the start, when the server initiates the event queue, the load is 0. If Event A is triggered, the load becomes 40. The remaining load that the app-instance can handle is 60. Therefore, Event B can also be started, which brings the total load to 90. At this point, Event C must wait until either Event A or B is completed because the current load is already at 90. However, if your app is running on Cloud Foundry with more than one instance, another instance with available capacity would process Event C.
443+
430444
# Keep Alive During Event Processing
431445

432446
The "Keep Alive During Event Processing" feature ensures system reliability by monitoring event processing activities.

0 commit comments

Comments
 (0)