Remove config duplication in examples#427
Merged
luoyuxia merged 1 commit intoapache:mainfrom Mar 7, 2026
Merged
Conversation
charlesdong1991
commented
Mar 5, 2026
| | `writer_retries` | `writer.retries` | Get/set number of retries on failure | | ||
| | `writer_batch_size` | `writer.batch-size` | Get/set write batch size in bytes | | ||
| | `writer_batch_timeout_ms` | `writer.batch-timeout-ms` | Get/set max time in ms to wait for a writer batch to fill up before sending | | ||
| | `writer_bucket_no_key_assigner` | `writer.bucket.no-key-assigner` | Get/set bucket assignment strategy (`"sticky"` or `"round_robin"`) | |
Contributor
Author
There was a problem hiding this comment.
this property seems to be mis-spelled, and also description is outdated as well because it now has both setter and getter
charlesdong1991
commented
Mar 5, 2026
| config.scanner_log_max_poll_records = 500; // Max records per poll | ||
| config.connect_timeout_ms = 120000; // TCP connect timeout (ms) | ||
| ``` | ||
| See the [`Configuration`](../api-reference.md#configuration) section in the API Reference for the full list of configuration fields, types, and defaults. |
Contributor
Author
There was a problem hiding this comment.
Different from what was proposed in the GH Issue, i think it's better to replace the duplicates in configuration.md in examples/, and reference api-reference instead.
Because configuration lives in examples, so intuitively to me, its primary role is showing how to use config with code examples.
fresh-borzoni
approved these changes
Mar 6, 2026
Contributor
fresh-borzoni
left a comment
fresh-borzoni
left a comment
There was a problem hiding this comment.
@charlesdong1991 TY for the PR, LGTM
luoyuxia
approved these changes
Mar 7, 2026
Contributor
luoyuxia
left a comment
luoyuxia
left a comment
There was a problem hiding this comment.
@charlesdong1991 Thanks for the pr and thanks @fresh-borzoni for reviewing. Merging..
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
3 participants
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.
Purpose
Linked issue: close #423
Brief change log
Replace duplicated config option tables in configuration.md in examples/ with cross-references to the authoritative tables in api-reference.md
Tests
No