docs: pipeline: outputs: kafka: document schema registry support - #2640
Merged
patrick-stephens merged 3 commits intoAug 7, 2026
Merged
Conversation
Document the schema_registry_* parameters for resolving Avro schemas from a Confluent Schema Registry, including subject and ID based resolution, basic and bearer authentication, multiple registry endpoints with failover, and the accepted dotted key spellings. Note, covers code merges without corresponding docs PR. Signed-off-by: Eric D. Schabell <eric@schabell.org>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe Kafka output documentation adds Confluent Schema Registry settings, runtime Avro schema resolution behavior, authentication and failover details, caching and retry information, and YAML/INI configuration examples. ChangesKafka Schema Registry
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Collaborator
Author
|
@patrick-stephens ready for review! |
…or schema registry Signed-off-by: Eric D. Schabell <eric@schabell.org>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@pipeline/outputs/kafka.md`:
- Around line 242-246: Update the authenticated Schema Registry examples around
schema_registry_url to use https:// endpoints, including the additional example,
so schema_registry_http_user and schema_registry_http_passwd credentials are not
sent over HTTP.
- Around line 221-225: Update the high-availability description near the schema
registry configuration to state that endpoint failover applies only to retry
attempts during the initial schema fetch, before the schema is successfully
resolved and cached. Remove the implication that the plugin performs later
schema resolutions or resumes from the last successful endpoint afterward.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 6223267c-a668-4532-97c1-a448b8b63ab2
📒 Files selected for processing (1)
pipeline/outputs/kafka.md
…security
- Scope endpoint failover to the initial schema fetch only; the schema
is cached for the plugin's lifetime and the registry isn't re-contacted
- Use https:// in the authenticated Schema Registry example so basic
auth credentials aren't shown going out over plain HTTP
Signed-off-by: Eric D. Schabell <eric@schabell.org>
patrick-stephens
approved these changes
Aug 7, 2026
patrick-stephens
pushed a commit
that referenced
this pull request
Aug 7, 2026
* docs: pipeline: outputs: kafka: document schema registry support
Document the schema_registry_* parameters for resolving Avro schemas
from a Confluent Schema Registry, including subject and ID based
resolution, basic and bearer authentication, multiple registry
endpoints with failover, and the accepted dotted key spellings.
Note, covers code merges without corresponding docs PR.
Signed-off-by: Eric D. Schabell <eric@schabell.org>
* docs: pipeline: outputs: kafka: note Avro encoder build requirement for schema registry
Signed-off-by: Eric D. Schabell <eric@schabell.org>
* docs: pipeline: outputs: kafka: fix schema registry doc accuracy and security
- Scope endpoint failover to the initial schema fetch only; the schema
is cached for the plugin's lifetime and the registry isn't re-contacted
- Use https:// in the authenticated Schema Registry example so basic
auth credentials aren't shown going out over plain HTTP
Signed-off-by: Eric D. Schabell <eric@schabell.org>
---------
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Signed-off-by: Patrick Stephens <pat@telemetryforge.io>
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
2 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.
Document the schema_registry_* parameters for resolving Avro schemas from a Confluent Schema Registry, including subject and ID based resolution, basic and bearer authentication, multiple registry endpoints with failover, and the accepted dotted key spellings.
Note, covers code merges without corresponding docs PR.
Summary by CodeRabbit