docs(postgres): document the replication_acceleration_rebuilt metric - #2133
Draft
claudespice wants to merge 2 commits into
Draft
docs(postgres): document the replication_acceleration_rebuilt metric#2133claudespice wants to merge 2 commits into
claudespice wants to merge 2 commits into
Conversation
spiceai/spiceai#13350 adds an auto-registered gauge that reports whether a dataset's acceleration was rebuilt rather than resumed on its last attach, and which of six causes applied.
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://00e4173a.spiceai-org-website.pages.dev |
Collaborator
Author
|
@copilot review |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Documents the PostgreSQL acceleration rebuild metric and its diagnostic causes.
Changes:
- Adds the metric to PostgreSQL metric references.
- Explains rebuild causes and alerting behavior.
- Links troubleshooting guidance to the new section.
File summaries
| File | Description |
|---|---|
website/docs/features/cdc/postgres-replication.md |
Documents rebuild detection, causes, and troubleshooting. |
website/docs/components/data-connectors/postgres/deployment.md |
Adds the metric and its attributes. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: claudespice <270518434+claudespice@users.noreply.github.com>
Contributor
Updated the troubleshooting wording to cover all rebuild causes in commit |
lukekim
marked this pull request as draft
September 2, 2026 19:38
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
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.
Summary
spiceai/spiceai#13350 registers a new auto-registered Postgres replication metric,
replication_acceleration_rebuilt, which the docs did not carry. It is the signal for a condition both Postgres pages already describe at length but gave no way to observe: an acceleration that was rebuilt from the source on its last attach instead of resuming from its recorded position — a full re-read of the table that nobody asked for.Verified against
origin/trunk:crates/data-connectors/connector-postgres/src/replication.rs:845-862—MetricSpec::new("replication_acceleration_rebuilt", MetricType::ObservableGaugeU64).auto_register(). That is 27 specs in the array against the 26 rows the deployment guide listed.1only whenrebuild_cause()isSome, with acauseattribute pushed onto the dataset attributes. A dataset that resumed reports no series rather than a constant0, so both pages say to alert on presence, not value.causevalues:crates/data_components/src/postgres_replication/mod.rs:366-374—no_record,foreign_source,unreadable,rewound_source,acknowledged_past,retention_lost, copied verbatim. Their meanings are from theRebuildCausevariant docs (same file, lines 332-359), including the two the code calls out explicitly:acknowledged_pastis not a WAL retention problem, andrewound_sourceis reason to check whether other datasets on the same source resumed when they should not have.Pages changed
website/docs/components/data-connectors/postgres/deployment.md— the metric row, plus thecauseattribute in the trailing attributes sentence.website/docs/features/cdc/postgres-replication.md— a new Detecting an unplanned rebuild section mapping eachcauseonto the rebuild/resume decision table already above it, a row in the core-signals table, and a pointer from the "whole table is re-read on a restart that used to resume" troubleshooting row.Cross-page grep:
grep -rln "replication_inserts_total" website/docs/→ these two Postgres pages andfeatures/cdc/mysql-replication.md; the MySQL page carries a different connector's metric set and is unaffected.Scope
vNext only (addition). spiceai/spiceai#13350 merged 2026-08-26 as
c04c6cff08, after thev2.2.0tag (2026-08-24);git tag --contains c04c6cff08is empty, so no released snapshot has this metric.Source PRs
Test plan
cd website && npm run buildpasses (new{#unplanned-rebuilds}anchor and the cross-page link to it resolve)