Skip to content

DOC-11498 Docs for obs: Support workload-level index recommendations and insights #19569

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Apr 28, 2025

Fixes DOC-11498

In insights.md include file, (1) added workload_index_recs function section and (2) updated the img tags to use files in v25.2 directory.

Rendered previews:

…ection and (2) updated the img tags to use files in v25.2 directory.
…ection and (2) updated the img tags to use files in v25.2 directory.
Copy link

Files changed:

Copy link

netlify bot commented Apr 28, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 2477277
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/681d1989ae7e6400082521e1

Copy link

netlify bot commented Apr 28, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 2477277
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/681d19893037b100080e9430

Copy link

netlify bot commented Apr 28, 2025

Netlify Preview

Name Link
🔨 Latest commit 2477277
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/681d19893adc06000868ad61
😎 Deploy Preview https://deploy-preview-19569--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@kevin-v-ngo kevin-v-ngo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @florence-crl, looks great and love the example joining with statement_statistics so that users can view the query text.

Can we add a description on the time window of the workload over which we look for index recommendations? The default behavior including allowing users to flexibly specifying a timestamp.

@kyle-a-wong, can you confirm the default behavior? If i recall, we take all the statements in statement_statistics. And if a timestamp is specified we filter and only consider those the statements after the timestamp.

@kyle-a-wong
Copy link
Contributor

Hi @florence-crl, looks great and love the example joining with statement_statistics so that users can view the query text.

Can we add a description on the time window of the workload over which we look for index recommendations? The default behavior including allowing users to flexibly specifying a timestamp.

@kyle-a-wong, can you confirm the default behavior? If i recall, we take all the statements in statement_statistics. And if a timestamp is specified we filter and only consider those the statements after the timestamp.

@kevin-v-ngo yes, the default behavior will return index_recommendations sourced from all statements in statement_statistics. Providing a time stamp, such as select workload_index_rec('2025-05-5') will only provide workload index recs that come after 2025-05-5 00:00:00

@florence-crl florence-crl requested a review from kevin-v-ngo May 8, 2025 20:53
@florence-crl
Copy link
Contributor Author

@kevin-v-ngo and @kyle-a-wong I added TIMESTAMPTZ parameter info. Please review again. thanks!

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.

3 participants