Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document point-in-time nature of /_status/tenant_ranges endpoint results #99048

Closed
abarganier opened this issue Mar 20, 2023 · 3 comments · Fixed by #116514
Closed

Document point-in-time nature of /_status/tenant_ranges endpoint results #99048

abarganier opened this issue Mar 20, 2023 · 3 comments · Fixed by #116514
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) docs-done docs-known-limitation

Comments

@abarganier
Copy link
Contributor

abarganier commented Mar 20, 2023

Is your feature request related to a problem? Please describe.
The /_status/tenant_ranges endpoint provides metadata about ranges for a tenant that exist at the time the request was processed.

The initial tenant creation process involves the creation of initial ranges, followed by an asynchronous process that splits ranges. If a user were to make a /_status/tenant_ranges immediately after tenant creation, it's possible that the client would receive a response containing a fewer number of ranges than they would receive if they made another request a short time after. This would be due to the asynchronous nature of this range splitting process.

Ranges are forever in a state of flux. Splitting, compaction, etc. are common operations that happen to ranges, and so this behavior should be intuitively expected by those who understand this. However, we should make this limitation clear in the documentation, to avoid potential confusion in scenarios such as the example one I gave above.

Describe the solution you'd like
Update documentation to note this characteristic of the /_status/tenant_ranges endpoint.

Additional context
Informs #97386

Jira issue: CRDB-25678

Informs: #92979

@blathers-crl
Copy link

blathers-crl bot commented Mar 20, 2023

Hi @abarganier, I've guessed the C-ategory of your issue and suitably labeled it. Please re-label if inaccurate.

While you're here, please consider adding an A- label to help keep our repository tidy.

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@blathers-crl blathers-crl bot added the C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) label Mar 20, 2023
@andf-crl
Copy link

Created DOC-7271 to track this.

@lnhsingh
Copy link
Contributor

lnhsingh commented May 3, 2023

Removing this from end-user-facing known limitations since this is an internal interface.
The docs for the internal interface is generated from code in cockroachdb/cockroach and can be updated to include info there. https://github.com/cockroachdb/cockroach/blob/master/docs/generated/http/full.md#tenantranges

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) docs-done docs-known-limitation
Projects
None yet
3 participants