Skip to content

DOC-15338: Remove metrics from Essential Metrics Advanced page#20972

Merged
florence-crl merged 11 commits intomainfrom
DOC-15338
Feb 4, 2026
Merged

DOC-15338: Remove metrics from Essential Metrics Advanced page#20972
florence-crl merged 11 commits intomainfrom
DOC-15338

Conversation

@florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Nov 4, 2025

Fixes DOC-15338 DOC-15492

In essential-metrics.md,
(a) for advanced only, show metrics that exist in the advanced_allowed_metrics list created from crdb_metrics.yaml and shared_metrics.yaml and
(b) Table Statistics section and LOGICAL_DATA_REPLICATION section are now self-hosted only.
(c) modified check for essential metrics to also check for visibility=ESSENTIAL.

Updated metrics.yaml files by running cockroach gen metric-list > metrics.yaml against v25.4.3 and v26.1.0-rc.1 binaries.

NOTE: sys_host_disk_iopsinprogress is in crdb_metrics.yaml so sys.host.disk.iopsinprogress appears for advanced.

Rendered preview

@netlify
Copy link

netlify bot commented Nov 4, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 6fd4a4b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/698385bb028f4d00074df834

@netlify
Copy link

netlify bot commented Nov 4, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 6fd4a4b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/698385bb97b8dd00083d1c37

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Files changed:

@netlify
Copy link

netlify bot commented Nov 4, 2025

Netlify Preview

Name Link
🔨 Latest commit 6fd4a4b
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/698385bba0e6780008acbfa1
😎 Deploy Preview https://deploy-preview-20972--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.

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, what should I be reviewing here?

I still see several "NOT AVAILABLE" metrics that should be removed from the docs. Is this automatically synced and will be removed at some point?

@florence-crl
Copy link
Contributor Author

@kevin-v-ngo

Hi Florence, what should I be reviewing here?

Rows for 4 metrics are no longer included for Advanced
sys.cpu.host.combined.percent-normalized
sys.host.disk.iopsinprogress
sql.mem.root.current
storage.write-stalls

For example, with this PR, a row for sys.host.disk.iopsinprogress will no longer appear: https://www.cockroachlabs.com/docs/v25.4/essential-metrics-advanced#sys-host-disk-iopsinprogress.

However, a row for sys.host.disk.read.bytes will still appear with "NOT AVAILABLE" in the second column: https://www.cockroachlabs.com/docs/v25.4/essential-metrics-advanced#sys-host-disk-read-bytes

I still see several "NOT AVAILABLE" metrics that should be removed from the docs. Is this automatically synced and will be removed at some point?

On this page (https://www.cockroachlabs.com/docs/v25.4/essential-metrics-advanced), there are 56 metrics with "NOT AVAILABLE" in the second column because these metrics do not have a match on the Datadog site (https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics). Please clarify whether these 56 rows should be displayed.
Thanks!

@florence-crl
Copy link
Contributor Author

discussed with @kevin-v-ngo , I will filter Essential Metrics for Advanced once #21152 is merged.

… check for visibility=ESSENTIAL.

Updated metrics.yaml files by running cockroach gen metric-list > metrics.yaml against v25.4.2 and v26.1.0-beta.2 binaries.
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.

LGTM

Copy link
Contributor

@taroface taroface left a comment

Choose a reason for hiding this comment

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

LGTM - just a small nit (typo).

{% assign datadog_prefix = "crdb_dedicated" %}
{% comment %} Removed NETWORKING category for advanced deployment {% endcomment %}
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,LOGICAL_DATA_REPLICATION,UNSET," %}
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATIOON categories for advanced deployment {% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATIOON categories for advanced deployment {% endcomment %}
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATION categories for advanced deployment {% endcomment %}

{% assign datadog_prefix = "crdb_dedicated" %}
{% comment %} Removed NETWORKING category for advanced deployment {% endcomment %}
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,LOGICAL_DATA_REPLICATION,UNSET," %}
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATIOON categories for advanced deployment {% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATIOON categories for advanced deployment {% endcomment %}
{% comment %} Removed NETWORKING AND LOGICAL_DATA_REPLICATION categories for advanced deployment {% endcomment %}

@florence-crl florence-crl merged commit 4a4bbfe into main Feb 4, 2026
6 checks passed
@florence-crl florence-crl deleted the DOC-15338 branch February 4, 2026 17:59
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