Skip to content

Update 'load' parameter details in documentation #433

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.

Sign up for GitHub

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

Merged
soccermax merged 1 commit into from
Feb 10, 2026
Merged

Update 'load' parameter details in documentation #433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/configure-event/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ they should be processed.
| type | Specifies the type of the event. | - |
| subType | Specifies the subtype of the event, further categorizing the event type. | - |
| namespace | Default namespace in which event is published | default |
| load | Indicates the load of the event, affecting the processing concurrency. | 1 |
| load | Number between 1 and 100 indicating the [load](#load) of the event, affecting the processing concurrency. | 1 |
| retryAttempts | Number of retry attempts for failed events. Set to `-1` for infinite retries. | 3 |
| processAfterCommit | Indicates whether an event is processed immediately after the transaction, in which the event was written, has been committed. | true |
| propagateHeaders | Specifies which headers from the original CDS context should be forwarded to the queue call. Provide an array of header names to propagate. | [] |
Expand Down Expand Up @@ -427,6 +427,20 @@ adjustment is made for event types in the queue for more than three minutes. The
remains in the queue for more than three minutes, its priority is temporarily bumped up by one level (i.e., from Low to
Medium).

# Load

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.

Consider the following scenario:

There are three events (irrespective of whether they are periodic or ad-hoc events).

- Event A has a specified load of 40.
- Event B has a specified load of 50.
- Event C has a specified load of 20.

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.

# Keep Alive During Event Processing

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