docs: add missing maxMessageBytes config to Kafka output tables#812
Open
detail-app[bot] wants to merge 1 commit intomasterfrom
Open
Conversation
This file contains hidden or 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
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.
Added documentation for the outputs[].config.maxMessageBytes parameter in the Kafka output configuration tables for sentry, cannon, and mimicry. This parameter was previously undocumented despite being implemented in the codebase.
Introduced by commit 1e346b0 (@samcm).
Without this documentation, developers configuring Kafka outputs would be unaware of the maxMessageBytes parameter and its distinction from flushBytes: maxMessageBytes controls the per-message size limit (messages exceeding it are dropped), while flushBytes controls the batch flush threshold. This could lead to unexpected message drops without understanding how to configure the proper limit.
Doc Drift PRs can be configured here.