Document Amazon Kinesis operators#328
Conversation
github-actions
Bot
added
reference
|
📦 Preview · View → · 🟢 Live Verified for |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38d8ba42cc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| title: from_amazon_kinesis | ||
| category: Inputs/Events | ||
| example: 'from_amazon_kinesis "security-events", start="trim_horizon"' |
There was a problem hiding this comment.
Additions of from_amazon_kinesis and to_amazon_kinesis are incomplete without updating src/content/docs/reference/operators.mdx (both the frontmatter operators: list and the ReferenceCard sections), so these operators will not appear in the main Operators catalog that users browse from /reference/operators. This makes the new docs effectively undiscoverable unless someone already knows the direct URL.
Useful? React with 👍 / 👎.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 91b0201a8f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| description: 'Receives messages from an AMQP queue.' | ||
| example: 'from_amqp "amqp://admin:pass@0.0.0.1:5672/vhost", queue="events"' | ||
| path: 'reference/operators/from_amqp' | ||
| - name: 'from_amazon_kinesis' |
There was a problem hiding this comment.
The insertion order violates the documented index rule in .agents/references/reference-index-pages.md (“Order entries alphabetically within their category section”): from_amazon_kinesis should sort before from_amqp, not after it. This leaves the operators index inconsistent (including the corresponding card section), which makes future index maintenance error-prone and can cause ordering checks/review drift.
Useful? React with 👍 / 👎.
| description: 'Sends messages to an AMQP exchange.' | ||
| example: 'to_amqp "amqp://admin:pass@0.0.0.1:5672/vhost"' | ||
| path: 'reference/operators/to_amqp' | ||
| - name: 'to_amazon_kinesis' |
There was a problem hiding this comment.
This entry is also out of alphabetical order per .agents/references/reference-index-pages.md: to_amazon_kinesis should appear before to_amqp. Keeping it here makes the index ordering inconsistent (and the related card list inconsistent too), which increases maintenance friction and invites follow-up churn whenever the operator index is updated.
Useful? React with 👍 / 👎.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9936532f72
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| </ReferenceCard> | ||
|
|
||
| <ReferenceCard title="to_amazon_kinesis" description="Sends records to an Amazon Kinesis data stream." href="/reference/operators/to_amazon_kinesis"> |
There was a problem hiding this comment.
The new to_amazon_kinesis card is inserted after to_amazon_security_lake, which breaks the required alphabetical ordering for operator index cards. The repository guidance in .agents/references/reference-index-pages.md explicitly requires alphabetical order within each category section, so this placement makes the index harder to maintain and inconsistent with the documented workflow.
Useful? React with 👍 / 👎.
|
@codex review |
|
Codex Review: Didn't find any major issues. 🚀 ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
🔍 Problem
The docs do not cover the Amazon Kinesis operators added in tenzir/tenzir#6188.
🛠️ Solution
from_amazon_kinesisandto_amazon_kinesis.💬 Review
Focus on whether the Kinesis restart semantics, payload handling, and AWS endpoint precedence are clear enough for a first operator version.
⚙️ Code PR: tenzir/tenzir#6188