Skip to content

DOC-15352: Replace use of metrics-list.csv with metrics.yaml in metrics generated pages #21072

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
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DOC-15352: Replace use of metrics-list.csv with metrics.yaml in metrics generated pages #21072

wants to merge 4 commits into from

Conversation

@florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Nov 10, 2025 •
edited
Loading

Fixes DOC-15352

  • In multi-dimensional-metrics-table.md, cockroachcloud/metrics-essential.md, and _includes/cockroachcloud/metrics-tab.md, updated to use metrics.yaml data file.
  • In metrics-cloud.yml, added how_to_use to 11 Request Units metrics and 4 other non-essential metrics.
  • In _includes/cockroachcloud/metrics-usage, deleted all files as well as directory and replaced with how_to_use in metric.yaml and metrics-cloud.yml.
  • Deleted metrics-list.csv.

Rendered previews

@florence-crl
In multi-dimensional-metrics-table.md, cockroachcloud/metrics-essenti…
fd02bdd 
…al.md, and _includes/cockroachcloud/metrics-tab.md, updated to use metrics.yaml data file.

In metrics-cloud.yml, added how_to_use to 11 Request Units metrics and 4 other non-essential metrics.

In _includes/cockroachcloud/metrics-usage, deleted all files as well as directory and replaced with how_to_use in metric.yaml and metrics-cloud.yml.
@florence-crl
Merge remote-tracking branch 'origin/main' into DOC-15352
b5a7dfe
@netlify
Copy link

netlify bot commented Nov 10, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 0a267b8
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6914d52b172b2900080f223c

@netlify
Copy link

netlify bot commented Nov 10, 2025 •
edited
Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 0a267b8
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6914d52b10f2d30008d541c9

@github-actions
Copy link

github-actions bot commented Nov 10, 2025 •
edited
Loading

Files changed:

  • src/current/_data/v25.4/metrics/metrics-cloud.yml
  • src/current/_data/v25.4/metrics/metrics-list.csv
  • src/current/_includes/cockroachcloud/metrics-tab.md:
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.commit_latency.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.emitted_bytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.emitted_messages.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.error_retries.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.failures.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/changefeed.running.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.auto_create_stats.currently_paused.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.auto_create_stats.currently_running.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.auto_create_stats.resume_failed.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.changefeed.currently_paused.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.changefeed.protected_age_sec.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.create_stats.currently_running.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.currently_paused.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.currently_running.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.delete_duration.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.resume_completed.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.resume_failed.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.rows_deleted.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.rows_selected.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.select_duration.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.total_expired_rows.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/jobs.row_level_ttl.total_rows.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/livebytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/schedules.scheduled-row-level-ttl-executor.failed.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.conn.latency.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.conns.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.ddl.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.delete.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.distsql.contended_queries.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.failure.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.full.scan.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.insert.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.new_conns.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.select.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.service.latency.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.statements.active.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txn.abort.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txn.begin.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txn.commit.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txn.latency.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txn.rollback.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.txns.open.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/sql.update.count.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.cross_region_network_ru.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.external_io_egress_bytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.pgwire_egress_bytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.read_batches.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.read_bytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.read_requests.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.request_units.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.sql_pods_cpu_seconds.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.write_batches.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.write_bytes.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/tenant.consumption.write_requests.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.asyncwritefailure.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.readwithinuncertainty.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.serializable.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.txnaborted.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.txnpush.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.unknown.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.writetooold.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/cockroachcloud/metrics-usage/txn.restarts.writetoooldmulti.md:
    • Warning: include not used in any cockroachcloud file or include
  • src/current/_includes/v25.4/multi-dimensional-metrics-table.md:
  • src/current/cockroachcloud/metrics-essential.md

@netlify
Copy link

netlify bot commented Nov 10, 2025 •
edited
Loading

✅ Netlify Preview

Name Link
🔨 Latest commit 0a267b8
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6914d52b9a7a8b000979a388
😎 Deploy Preview https://deploy-preview-21072--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 project configuration.

@florence-crl florence-crl requested a review from mikeCRL November 10, 2025 21:42
mikeCRL
mikeCRL approved these changes Nov 12, 2025
View reviewed changes
Copy link
Contributor

@mikeCRL mikeCRL left a comment

Choose a reason for hiding this comment

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

Looks great. One small fix needed:

In src/current/_data/v25.4/metrics/metrics-cloud.yml these three metrics have an extra ' at the end of their how_to_use field, just after refer to Resource Usage.

  1. tenant.consumption.request_units
  2. tenant.consumption.sql_pods_cpu_seconds
  3. tenant.consumption.pgwire_egress_bytes

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

Reviewers

@mikeCRL mikeCRL mikeCRL approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@florence-crl @mikeCRL