[WEB-4194] Conflation ControlAPI #2416
Open
+34
−15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
m-hulbert
requested changes
Jan 31, 2025
denissellu
force-pushed
the
WEB-4194-conflation-control-api
branch
from
2fbb4d7 to
9f02730
Compare
m-hulbert
force-pushed
the
WEB-4194-conflation-control-api
branch
from
9f02730 to
7ca7e40
Compare
m-hulbert
requested changes
Apr 8, 2025
static/open-specs/control-v1.yaml
Outdated
| batchingInterval: | ||
| type: integer | ||
| default: 20 | ||
| description: If `true`, the batching interval, configurable from 20ms to 1s, temporarily holds and aggregates incoming messages. These messages are then combined and delivered as a single batch once the interval elapses or a size limit is reached (before the interval elapses). | ||
| example: 20 | ||
| conflationEnabled: | ||
| default: false | ||
| description: If `true`, enables conflation for channels within this namespace. Conflation reduces the number of messages sent to subscribers by combining multiple messages into a single message. |
There was a problem hiding this comment.
Suggested change
| description: If `true`, enables conflation for channels within this namespace. Conflation reduces the number of messages sent to subscribers by combining multiple messages into a single message. | |
| description: If `true`, enables <a href="https://ably.com/docs/messages#conflation">conflation</a> for channels within this namespace. Conflation will aggregate published messages for a set period of time and evaluate them against a conflation key. Only the most recent message that satisfies the key will be sent to subscribers at the end of the conflation interval. |
static/open-specs/control-v1.yaml
Outdated
| example: false | ||
| conflationInterval: | ||
| type: integer | ||
| description: The interval in milliseconds at which messages are conflated. This determines how frequently messages are combined into a single message. |
There was a problem hiding this comment.
Suggested change
| description: The interval in milliseconds at which messages are conflated. This determines how frequently messages are combined into a single message. | |
| description: The interval in milliseconds over which messages are held and evaluated for conflation. |
static/open-specs/control-v1.yaml
Outdated
| example: 1000 | ||
| conflationKey: | ||
| type: string | ||
| description: The key used to determine which messages should be conflated. Messages with the same conflation key will be combined into a single message. |
There was a problem hiding this comment.
Suggested change
| description: The key used to determine which messages should be conflated. Messages with the same conflation key will be combined into a single message. | |
| description: The <a href="https://ably.com/docs/messages#routing">key</a> used to determine which messages should be conflated. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See WEB-4194 for more details
Add ControlAPI fields to namespaces for conflation, and clean up batching fields
This pull request includes changes to the
static/open-specs/control-v1.yamlfile to update the message batching and conflation configurations. The most important changes involve the removal of thebatchingPolicyfield and the addition of new fields related to message conflation.Changes to message batching and conflation configurations:
batchingPolicyfield from the configuration. [1] [2] [3]batchingIntervaldescription to clarify its role in determining the frequency of message batching.conflationEnabledfield to enable or disable message conflation.conflationIntervalfield to specify the interval at which messages are conflated.conflationKeyfield to determine which messages should be conflated based on a key.