Skip to content

DOC-14122 Redo essential metrics page to use new metrics.yaml file #19847

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 13 commits into
base: main
Choose a base branch
from

Conversation

florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Jun 27, 2025

Fixes DOC-14122

  • Updated include file essential-metrics.md to use new yaml and csv files.
  • Renamed metrics.yml to metrics-cloud.yml for v25.2 and v25.3.
  • In cockroachcloud metrics-tab.md and metrics-essential.md, replaced use of metrics.metrics with metrics.metrics-cloud.
  • Added metrics.yaml generated from cockroach gen metric-list with v25.3.0-beta.1.
  • Replaced available-metrics-not-in-metrics-list.csv with available-metrics-not-in-metrics-list.yaml with labeled_name and essential: true.
  • Added datadog-cockroachdb.csv, manually created from https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#metrics.
  • Added datadog-crdb-dedicated.csv, manually created from https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics.
  • In essential-metrics-self-hosted.md, replaced liquid variable with hard coded string in frontmatter.
  • In essential-alerts.md, fixed link.

Rendered preview

-v25.3 Essential Metrics for self-hosted
-v25.3 Essential Metrics for Advanced

In cockroachcloud metrics-tab.md and metrics-essential.md, replaced use of metrics.metrics with metrics.metrics-cloud.

Added v25.3/metrics-essential.md and metrics.yaml with manually hardcoded SQL_2 category.
Copy link

github-actions bot commented Jun 27, 2025

Files changed:

Copy link

netlify bot commented Jun 27, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 07e15db
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6866e3c4bb8ed2000912fadc

Copy link

netlify bot commented Jun 27, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 07e15db
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6866e3c491a83b0007547f8f

Copy link

netlify bot commented Jun 27, 2025

Netlify Preview

Name Link
🔨 Latest commit 07e15db
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6866e3c4abec9e000892a5d7
😎 Deploy Preview https://deploy-preview-19847--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.

…nd added Datadog Integration Metric Name column

Added datadog-cockroachdb.csv, manually created from https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#metrics.

In metrics.yaml, removed manually hardcoded SQL_2 category.
Added datadog-crdb-dedicated.csv, manually created from https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics.

Added metrics-essential-advanced.md.
In essential-metrics-self-hosted.md, replaced liquid variable with hard coded string in frontmatter.md

Deleted metrics-essential-self-hosted.md and metrics-essential-advanced.md.
…derscores and periods with hyphens in metric name, (2) added category Expiration of license and certificates.

Replaced available-metrics-not-in-metrics-list.csv with available-metrics-not-in-metrics-list.yaml with labeled_name and essential: true.

In essential-alerts.md, fixed link.
…ster Recovery.

Regenerated metrics.yaml using v25.3.0-beta.1.
@florence-crl florence-crl requested a review from kevin-v-ngo July 3, 2025 20:20
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.

1 participant