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.

Sign up for GitHub

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

Jump to bottom

DOC-9513 Docs for Canned metric dashboards in the CockroachDB Cloud console #18283

Closed
wants to merge 8 commits into from
Closed

DOC-9513 Docs for Canned metric dashboards in the CockroachDB Cloud console #18283

wants to merge 8 commits into from

Conversation

florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Feb 8, 2024 •
edited
Loading

Fixes DOC-9513 DOC-9632 DOC-9577

DOC-9513 Serverless Canned Metrics
DOC-9632 Serverless Essential Metrics
DOC-9577 Serverless Resource Usage

Rendered pages:
Overview
Request Units
SQL
Changefeeds
Row-Level TTL
Essential Metrics for Serverless
Serverless Resource Usage

metrics-list.csv was generated using the v23.2.0 binary with the following command:
cockroach gen metric-list --format=csv > metrics-list.csv
Once generated, metrics-list.csv was manually modified to change the case of the headers to lowercase to work with liquid comparison code.

In serverless-resource-usage.md, (a) added links to new canned metrics pages, particularly Request Units metrics, (b) promoted General Tips section to header 2 and created sections for types of resource usage, (c ) incorporated recommendations from internal wiki page.

@netlify Netlify
Copy link

netlify bot commented Feb 8, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 3522ac0
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/65d8e3e75a1c5f00085de269

@netlify Netlify
Copy link

netlify bot commented Feb 8, 2024 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 3522ac0
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/65d8e3e75a85b300088eb4c4

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 8, 2024 •
edited
Loading

Files changed:

  • src/current/_data/metrics-list.csv
  • src/current/_data/metrics.yml
  • src/current/_includes/metrics-usage/changefeed.commit_latency.md
  • src/current/_includes/metrics-usage/changefeed.emitted_bytes.md
  • src/current/_includes/metrics-usage/changefeed.emitted_messages.md
  • src/current/_includes/metrics-usage/changefeed.error_retries.md
  • src/current/_includes/metrics-usage/changefeed.failures.md
  • src/current/_includes/metrics-usage/changefeed.running.md
  • src/current/_includes/metrics-usage/jobs.auto_create_stats.currently_paused.md
  • src/current/_includes/metrics-usage/jobs.auto_create_stats.currently_running.md
  • src/current/_includes/metrics-usage/jobs.auto_create_stats.resume_failed.md
  • src/current/_includes/metrics-usage/jobs.changefeed.currently_paused.md
  • src/current/_includes/metrics-usage/jobs.changefeed.protected_age_sec.md
  • src/current/_includes/metrics-usage/jobs.create_stats.currently_running.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.currently_paused.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.currently_running.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.delete_duration.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.resume_completed.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.resume_failed.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.rows_deleted.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.rows_selected.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.select_duration.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.total_expired_rows.md
  • src/current/_includes/metrics-usage/jobs.row_level_ttl.total_rows.md
  • src/current/_includes/metrics-usage/livebytes.md
  • src/current/_includes/metrics-usage/schedules.scheduled-row-level-ttl-executor.failed.md
  • src/current/_includes/metrics-usage/sql.conn.latency.md
  • src/current/_includes/metrics-usage/sql.conns.md
  • src/current/_includes/metrics-usage/sql.ddl.count.md
  • src/current/_includes/metrics-usage/sql.delete.count.md
  • src/current/_includes/metrics-usage/sql.distsql.contended_queries.count.md
  • src/current/_includes/metrics-usage/sql.failure.count.md
  • src/current/_includes/metrics-usage/sql.full.scan.count.md
  • src/current/_includes/metrics-usage/sql.insert.count.md
  • src/current/_includes/metrics-usage/sql.new_conns.md
  • src/current/_includes/metrics-usage/sql.select.count.md
  • src/current/_includes/metrics-usage/sql.service.latency.md
  • src/current/_includes/metrics-usage/sql.statements.active.md
  • src/current/_includes/metrics-usage/sql.txn.abort.count.md
  • src/current/_includes/metrics-usage/sql.txn.begin.count.md
  • src/current/_includes/metrics-usage/sql.txn.commit.count.md
  • src/current/_includes/metrics-usage/sql.txn.latency.md
  • src/current/_includes/metrics-usage/sql.txn.rollback.count.md
  • src/current/_includes/metrics-usage/sql.txns.open.md
  • src/current/_includes/metrics-usage/sql.update.count.md
  • src/current/_includes/metrics-usage/tenant.consumption.cross_region_network_ru.md
  • src/current/_includes/metrics-usage/tenant.consumption.external_io_egress_bytes.md
  • src/current/_includes/metrics-usage/tenant.consumption.pgwire_egress_bytes.md
  • src/current/_includes/metrics-usage/tenant.consumption.read_batches.md
  • src/current/_includes/metrics-usage/tenant.consumption.read_bytes.md
  • src/current/_includes/metrics-usage/tenant.consumption.read_requests.md
  • src/current/_includes/metrics-usage/tenant.consumption.request_units.md
  • src/current/_includes/metrics-usage/tenant.consumption.sql_pods_cpu_seconds.md
  • src/current/_includes/metrics-usage/tenant.consumption.write_batches.md
  • src/current/_includes/metrics-usage/tenant.consumption.write_bytes.md
  • src/current/_includes/metrics-usage/tenant.consumption.write_requests.md
  • src/current/_includes/metrics-usage/txn.restarts.asyncwritefailure.md
  • src/current/_includes/metrics-usage/txn.restarts.readwithinuncertainty.md
  • src/current/_includes/metrics-usage/txn.restarts.serializable.md
  • src/current/_includes/metrics-usage/txn.restarts.txnaborted.md
  • src/current/_includes/metrics-usage/txn.restarts.txnpush.md
  • src/current/_includes/metrics-usage/txn.restarts.unknown.md
  • src/current/_includes/metrics-usage/txn.restarts.writetooold.md
  • src/current/_includes/metrics-usage/txn.restarts.writetoooldmulti.md
  • src/current/_includes/v23.2/sidebar-data/cloud-deployments.json
  • src/current/cockroachcloud/metrics-changefeeds.md
  • src/current/cockroachcloud/metrics-essential-serverless.md
  • src/current/cockroachcloud/metrics-overview.md
  • src/current/cockroachcloud/metrics-page.md
  • src/current/cockroachcloud/metrics-request-units.md
  • src/current/cockroachcloud/metrics-row-level-ttl.md
  • src/current/cockroachcloud/metrics-sql.md
  • src/current/cockroachcloud/serverless-resource-usage.md

@netlify Netlify
Copy link

netlify bot commented Feb 8, 2024 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit 3522ac0
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/65d8e3e7d9b35600080c36e0
😎 Deploy Preview https://deploy-preview-18283--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.

@exalate-issue-sync exalate-issue-sync bot mentioned this pull request Feb 12, 2024
Closed
@florence-crl
DOC-9513 Serverless Canned Metrics
bd4155f 
DOC-9632 Serverless Essential Metrics
@florence-crl
Copy link
Contributor Author

incorporated feedback from

@rmloveland and @kevin-v-ngo, please review at your convenience.

@florence-crl
In serverless-resource-usage.md, (a) added links to new canned metric…
5a09a54 
…s pages, particularly Request Units metrics, (b) promoted General Tips section to header 2 and created sections for types of resource usage, (c ) incorporated recommendations from internal wiki page.
@florence-crl
Copy link
Contributor Author

florence-crl commented Feb 15, 2024 •
edited
Loading

Hi @Amruta-Ranade & @kevin-v-ngo & @andy-kimball, please review this additional page:
Serverless Resource Usage

@florence-crl florence-crl mentioned this pull request Feb 15, 2024
Closed
rmloveland
rmloveland approved these changes Feb 16, 2024
View reviewed changes
Copy link
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

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

LGTM!!!!

Left some comments about updates I think are needed but overall this is such a HUGE WIN

THANK YOU

src/current/_data/metrics.yml Show resolved Hide resolved
src/current/cockroachcloud/metrics-essential-serverless.md Show resolved Hide resolved
src/current/cockroachcloud/metrics-request-units.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_batches.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_batches.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_bytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_requests.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/txn.restarts.unknown.md Outdated Show resolved Hide resolved
@florence-crl
incorporated rmloveland feedback, (1) In metrics-usage changefeed fil…
baae762 
…es, add link to changefeed(s).
@florence-crl
incorporated rmloveland and andy-kimball feedback, (1) In metrics-usa…
5169586 
…ge table statistics and row_level_ttl files, added links. (2) in metrics-essential-serverless, added anchors to metric names.
@florence-crl
incorporated rmloveland feedback, (1) In metrics-usage sql and txn fi…
be1c868 
…les, added links and updated formatting.
florence-crl
florence-crl commented Feb 21, 2024
View reviewed changes
Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

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

TFTRs! I updated my local branch with the changes addressed so far. When I finish addressing all the suggestions, I will update the PR.

src/current/_includes/metrics-usage/changefeed.commit_latency.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/changefeed.commit_latency.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/jobs.auto_create_stats.currently_paused.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/jobs.auto_create_stats.currently_running.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/jobs.row_level_ttl.currently_paused.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/sql.service.latency.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/sql.txn.abort.count.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/sql.txn.latency.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/sql.txn.rollback.count.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/sql.update.count.md Outdated Show resolved Hide resolved
@florence-crl
incorporated rmloveland and andy-kimball feedback, (1) In metrics-*.m…
f4db628 
…d files, added div with anchor link. (2) In metrics-usage tenant.consumption files, added links.
florence-crl
florence-crl commented Feb 22, 2024
View reviewed changes
Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

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

I updated my local branch with more suggested changes.

src/current/_includes/metrics-usage/livebytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/livebytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/livebytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.cross_region_network_ru.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.external_io_egress_bytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_batches.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_batches.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_bytes.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/tenant.consumption.write_requests.md Outdated Show resolved Hide resolved
src/current/_includes/metrics-usage/txn.restarts.unknown.md Outdated Show resolved Hide resolved
@florence-crl
incorporated rmloveland and andy-kimball feedback, (1) In metrics-ess…
c04b107 
…ential-serverless.md, added See also section. (2) In metrics-request-units.md, added links. (3) In serverless-resource-usage.md, added links.
florence-crl
florence-crl commented Feb 22, 2024
View reviewed changes
Copy link
Contributor Author

@florence-crl florence-crl left a comment

Choose a reason for hiding this comment

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

I added the final updates to my local branch, I will push it to the PR tomorrow.

src/current/cockroachcloud/metrics-essential-serverless.md Show resolved Hide resolved
src/current/cockroachcloud/metrics-request-units.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
src/current/cockroachcloud/serverless-resource-usage.md Outdated Show resolved Hide resolved
kevin-v-ngo
kevin-v-ngo approved these changes Mar 8, 2024
View reviewed changes
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.

Nice docs Florence!!

@florence-crl
Copy link
Contributor Author

Even though these docs have been approved, ONLY merge into main when this feature has been officially enabled in production.

@florence-crl florence-crl mentioned this pull request Mar 13, 2024
Merged
@florence-crl
Copy link
Contributor Author

Closing this PR in favor of PR 18362. See DOC-9513, for context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevin-v-ngo kevin-v-ngo kevin-v-ngo approved these changes

@Amruta-Ranade Amruta-Ranade Amruta-Ranade approved these changes

@rmloveland rmloveland rmloveland approved these changes

@andy-kimball andy-kimball Awaiting requested review from andy-kimball

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@florence-crl @rmloveland @Amruta-Ranade @andy-kimball @kevin-v-ngo