docs(external): Clarify docs for Azure Event Hubs (Kafka) input #23280
+12
−3
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
github-actions
bot
added
the
domain: external docs
|
(The automatic spellcheck is wrong.) |
Some issues were a bit maddening to debug until we realised some simple mistakes in configs we forgot to check.
nemobis
force-pushed
the
federicol-kafka-groups
branch
from
daeab4e to
9d03a86
Compare
pront
reviewed
Jun 27, 2025
| @@ -505,7 +505,11 @@ base: components: sources: kafka: configuration: { | |||
| } | |||
| } | |||
| group_id: { | |||
| description: "The consumer group name to be used to consume events from Kafka." | |||
| description: """ | |||
There was a problem hiding this comment.
This file is generated and we don't modify by hand. Instead, this new description should be a /// comment on the group_id in src/sources/kafka.rs. Then you can make generate-component-docs to generate this file.
| @@ -103,6 +104,9 @@ components: _kafka: { | |||
| - `tls.enabled` - Set to `true`. | |||
| - `tls.ca_file` - The certificate authority file. | |||
| - `tls.verify_certificate` - Set to `true`. | |||
| If you see AllBrokerDown errors every 5 minutes (the default interval between rebootstrap), that may | |||
There was a problem hiding this comment.
To fix the error, add rebootstrap in the allow.txt.
| @@ -103,6 +104,9 @@ components: _kafka: { | |||
| - `tls.enabled` - Set to `true`. | |||
| - `tls.ca_file` - The certificate authority file. | |||
| - `tls.verify_certificate` - Set to `true`. | |||
| If you see AllBrokerDown errors every 5 minutes (the default interval between rebootstrap), that may | |||
There was a problem hiding this comment.
This can be slightly rephrased.
If you see `AllBrokerDown` errors every five minutes (the default “rebootstrap” interval), it usually just means there are no new records to fetch. If you were expecting new data, double-check your group_id; if you’re actually hitting network hiccups, verify your keepalive, socket timeout and other retry/interval settings.
There was a problem hiding this comment.
Suggested change
| If you see AllBrokerDown errors every 5 minutes (the default interval between rebootstrap), that may | |
| If you see `AllBrokerDown` errors every five minutes (the default “rebootstrap” interval), it usually means there are no new records to fetch. If you are expecting new data, double-check your `group_id`; if you’re actually hitting network hiccups, verify your `keepalive`, socket timeout and other retry or interval settings. |
pront
changed the title
pront
added
the
no-changelog
estherk15
approved these changes
Jun 27, 2025
| @@ -103,6 +104,9 @@ components: _kafka: { | |||
| - `tls.enabled` - Set to `true`. | |||
| - `tls.ca_file` - The certificate authority file. | |||
| - `tls.verify_certificate` - Set to `true`. | |||
| If you see AllBrokerDown errors every 5 minutes (the default interval between rebootstrap), that may | |||
There was a problem hiding this comment.
Suggested change
| If you see AllBrokerDown errors every 5 minutes (the default interval between rebootstrap), that may | |
| If you see `AllBrokerDown` errors every five minutes (the default “rebootstrap” interval), it usually means there are no new records to fetch. If you are expecting new data, double-check your `group_id`; if you’re actually hitting network hiccups, verify your `keepalive`, socket timeout and other retry or interval settings. |
| @@ -505,7 +505,11 @@ base: components: sources: kafka: configuration: { | |||
| } | |||
| } | |||
| group_id: { | |||
| description: "The consumer group name to be used to consume events from Kafka." | |||
| description: """ | |||
| The consumer group name to be used to consume events from Kafka. Must be unique across Vector instances if they all are to consume the same events. If two instances (consumers) share the same group name, any event will be received by only one of them. | |||
There was a problem hiding this comment.
Suggested change
| The consumer group name to be used to consume events from Kafka. Must be unique across Vector instances if they all are to consume the same events. If two instances (consumers) share the same group name, any event will be received by only one of them. | |
| The consumer group name used to consume events from Kafka. Must be unique across Vector instances if each is expected to consume the same events. If two instances (consumers) share the same group name, each event is delivered to only one instance. |
thomasqueirozb
added
the
meta: awaiting author
pront
force-pushed
the
master
branch
4 times, most recently
from
1720078 to
ffe54be
Compare
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.
Some issues were a bit maddening to debug until we realised some simple mistakes in configs we forgot to check.
Summary
Vector configuration
How did you test this PR?
Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.References
Notes
@vectordotdev/vectorto reach out to us regarding this PR.pre-pushhook, please see this template.cargo fmt --allcargo clippy --workspace --all-targets -- -D warningscargo nextest run --workspace(alternatively, you can runcargo test --all)git merge origin masterandgit push.Cargo.lock), pleaserun
cargo vdev build licensesto regenerate the license inventory and commit the changes (if any). More details here.