Add zone config troubleshooting guide #19283
Open
Conversation
This file contains 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
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
7 times, most recently
from
e8df32a to
674915d
Compare
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
6 times, most recently
from
e11a980 to
d460824
Compare
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
3 times, most recently
from
fc2c697 to
ab3faec
Compare
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
from
ab3faec to
fb31a32
Compare
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
2 times, most recently
from
0f0bfde to
a2f820e
Compare
Fixes DOC-9210 Summary of changes: - Add a new page, 'Troubleshoot Replication Zones', to _The ZoneConfigonomicon (tm)_ - Update the 'Replication controls' page with more detailed info re: zone config inheritance hierarchy and behavior - Update the made-up examples in the 'Critical nodes endpoint' docs to point back to 'Troubleshoot Replication Zones' - Fix incorrect statements on the `ALTER RANGE` page since they're needed to map from range IDs returned by the critical nodes endpoint (mentioned in 'Troubleshoot Replication Zones') to actual schema objects - Add moar links (tm) from various zone config-related pages to the new troubleshooting guide and amongst themselves - Add a note to various zone config-related docs saying "most users should not do manual zone config changes, see Multi-region SQL and Zone Config Extensions instead"
rmloveland
force-pushed
the
20241209-DOC-9210-zone-config-troubleshooting-guide
branch
from
a2f820e to
a91c384
Compare
rmloveland
commented
Feb 4, 2025
|
|
||
| The following example query uses the [`SHOW RANGES`]({% link {{ page.version.version }}/show-ranges.md %}) statement to show, for each range ID, which tables and indexes use that range for their underlying storage. The query assumes the [`movr` schema]({% link {{ page.version.version }}/movr.md %}#the-movr-database) that is loaded by [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %}), so you'll need to modify it to work with your schema. | ||
|
|
||
| XXX: GET HELP WITH THIS QUERY, OUTPUT SEEMS NOT QUITE RIGHT??? (or is it ok?) |
There was a problem hiding this comment.
(as you can see the output is maybe not the best)
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.
Fixes DOC-9210
Summary of changes:
Add a new page, 'Troubleshoot Replication Zones', to The
ZoneConfigonomicon (tm)
Update the 'Replication controls' page with more detailed info re:
zone config inheritance hierarchy and behavior
Update the made-up examples in the 'Critical nodes endpoint' docs to
point back to 'Troubleshoot Replication Zones'
Fix incorrect statements on the
ALTER RANGEpage since they'reneeded to map from range IDs returned by the critical nodes
endpoint (mentioned in 'Troubleshoot Replication Zones') to actual
schema objects
Add moar links (tm) from various zone config-related pages to the new
troubleshooting guide and amongst themselves
Add a note to various zone config-related docs saying "most users
should not do manual zone config changes, see Multi-region SQL and
Zone Config Extensions instead"
For reviewers, the main changes are:
SHOW RANGESqueries to get them to actually work (they were missing the... WITH DETAILSclause, and/or usingcrdb_internal.ranges- this was a bit of a driveby change but seemed good to do since I was touchingALTER RANGE ... CONFIGURE ZONEto point to the troubleshooting guide