← 输入框|github.com|刷新
Skip to content

[docs] Link the Kafka output delivery guarantees from the pages that need them - #7683

Merged
bestouff merged 1 commit into
mainfrom
issue-7578-step4
Oct 30, 2026
Merged

bestouff merged 1 commit into
mainfrom
issue-7578-step4

Conversation

@bestouff

@bestouff bestouff commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Linked Issue

Last step for #7578, stacked on #7682. Documentation only: links the Kafka sink's delivery, recovery and metrics sections from the pages a reader starts from.

Page Change
pipelines/fault-tolerance.md today only the Kafka output connector supports exactly-once output; link to its recovery section
operations/metrics.md.in, metrics.md output connectors can export metrics of their own; links to Kafka and Delta Lake
connectors/sinks/kafka.md the introduction links the delivery sections and the metrics table

Describe Manual Test Plan

Prose only. Every new anchor exists on its target page.

Checklist

Breaking Changes?

None.

@mythical-fred-oss

Copy link
Copy Markdown
Contributor

LGTM. This PR only changes docs, so the test gates don't apply. What I checked:

  • All three new anchors resolve on the Kafka sink page in the merged tree: #delivery-retries-and-backpressure, #exactly-once-delivery-and-recovery, #output-metrics.
  • The new metrics paragraph is the same in metrics.md.in and metrics.md, and it sits outside the {{output_connector_}} block, so regenerating metrics.md will keep it.
  • The claim that Kafka is the only exactly-once sink holds in the code. In crates/connectors, is_fault_tolerant() returns true only for kafka/ft and the null sink. Snowflake and Confluent JDBC count too, because they run on the Kafka output connector.
  • pre-commit run --files <4 changed files> passed.

@bestouff
bestouff added this pull request to stack #7686 October 28, 2026 19:05
@bestouff
bestouff marked this pull request as ready for review October 28, 2026 19:17
@mythical-fred-oss

Copy link
Copy Markdown
Contributor

LGTM (docs only, stacked on #7682).

What I checked

  • Every new link target exists: kafka#delivery-retries-and-backpressure, #exactly-once-delivery-and-recovery, #output-metrics, and delta#metrics.
  • The claim "today only the Kafka output connector supports exactly-once output" holds in the code. is_fault_tolerant() returns true only for kafka/ft/output.rs, plus the null sink, which drops everything anyway. Delta, Postgres, NATS, Redis, S2, DynamoDB, file and HTTP all return false.
  • The metrics.md.in and metrics.md edits are identical, so regenerating with metrics.py keeps them in sync.
  • pre-commit run --files <4 changed files> passed.

Commit history (medium): the second commit, "Scope the exactly-once statement…", says it is review feedback. Please squash it into the first commit before merge, to keep main's history linear and clean.

@bestouff
bestouff force-pushed the issue-7578-step4 branch 2 times, most recently from 4f61f74 to 373bec8 Compare October 29, 2026 13:00
@bestouff
bestouff added this pull request to the merge queue Oct 29, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue because a pull request earlier in the stack was removed Oct 29, 2026
@bestouff
bestouff added this pull request to the merge queue Oct 29, 2026
@bestouff
bestouff removed this pull request from the merge queue due to a manual request Oct 29, 2026
@mihaibudiu
mihaibudiu added this pull request to the merge queue Oct 30, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue because the pull requests in the stack were not ordered correctly in the queue Oct 30, 2026
@mihaibudiu
mihaibudiu added this pull request to the merge queue Oct 30, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to invalid changes in the merge commit Oct 30, 2026
Base automatically changed from issue-7578-step3 to main October 30, 2026 10:05
…need them

The Kafka sink page now documents delivery, retries, backpressure, health,
exactly-once recovery and the connector's metrics, but the pages a reader
starts from did not point there. The fault tolerance page says that output
connectors document their own support, that today only the Kafka output
connector supports exactly-once output, and links its recovery section.
The metrics reference says that output connectors can export metrics of
their own and points at the Kafka and Delta Lake pages. The sink page's
introduction links its own delivery sections.

Fourth step for #7578, stacked on #7682.

Signed-off-by: Xavier Bestel <xavier.bestel@feldera.com>
@bestouff
bestouff added this pull request to the merge queue Oct 30, 2026
Merged via the queue into main with commit 014fe10 Oct 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants