Skip to content

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

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

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

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9497644
In essential-metrics.md, added check for advanced_excluded_metrics.
florence-crl Nov 4, 2025
7510508
Merge remote-tracking branch 'origin/main' into DOC-15338
florence-crl Dec 9, 2025
cd5c25f
Merge remote-tracking branch 'origin/main' into DOC-15338
florence-crl Dec 9, 2025
1ff488f
In essential-metrics.md, for advanced only shows metrics that exist i…
florence-crl Dec 11, 2025
909525f
Merge remote-tracking branch 'origin/main' into DOC-15338
florence-crl Dec 11, 2025
3c90369
Copy essential-metrics.md to v26.1.
florence-crl Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 48 additions & 8 deletions src/current/_includes/v25.4/essential-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,24 @@ These essential CockroachDB metrics let you monitor your CockroachDB {{ site.dat
{% assign metrics_datadog = site.data[version].metrics.datadog-crdb-dedicated %}
{% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics" %}
{% 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 %}
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,UNSET," %}

{% comment %} Build list of allowed metrics from export YAML files {% endcomment %}
{% assign crdb_metrics = site.data[version].metrics.export.crdb_metrics.metrics %}
{% assign shared_metrics = site.data[version].metrics.export.shared_metrics.metrics %}

{% comment %} Extract metric names into a combined string for lookup {% endcomment %}
{% assign advanced_allowed_metrics = "|" %}
{% for metric_pair in crdb_metrics %}
{% assign metric_name = metric_pair[0] %}
{% assign advanced_allowed_metrics = advanced_allowed_metrics | append: metric_name | append: "|" %}
{% endfor %}
{% for metric_pair in shared_metrics %}
{% assign metric_name = metric_pair[0] %}
{% assign advanced_allowed_metrics = advanced_allowed_metrics | append: metric_name | append: "|" %}
{% endfor %}
{% comment %}DEBUG: advanced_allowed_metrics length = {{ advanced_allowed_metrics | size }}{% endcomment %}

These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.advanced }} cluster. Use them to build custom dashboards with the following tools:

Expand Down Expand Up @@ -122,7 +138,17 @@ The **Usage** column explains why each metric is important to visualize and how
{% for metric in essential_metrics %}
{% comment %} STEP 4d. Exclude SQL metrics that will be placed in special categories {% endcomment %}
{% unless category_name == SQL %}
{% unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats" %}
{% comment %} For advanced deployment, only show metrics that exist in export YAML files {% endcomment %}
{% assign metric_normalized = metric.name | replace: ".", "_" | replace: "-", "_" %}
{% assign show_metric = false %}
{% if include.deployment == 'self-hosted' %}
{% assign show_metric = true %}
{% elsif advanced_allowed_metrics contains metric_normalized %}
{% assign show_metric = true %}
{% endif %}

{% if show_metric %}
{% unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats" %}

{% comment %} Transforms to match datadog_id {% endcomment %}
{% assign input_metric = metric.name %}
Expand Down Expand Up @@ -162,7 +188,8 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endunless %}{% comment %}unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats"{% endcomment %}
{% endunless %}{% comment %}unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats"{% endcomment %}
{% endif %}{% comment %}if show_metric{% endcomment %}
{% endunless %}{% comment %}unless category_name == SQL{% endcomment %}
{% endfor %}{% comment %}for metric in essential_metrics{% endcomment %}
{% endfor %}{% comment %}for layer in layer_names_array{% endcomment %}
Expand All @@ -178,6 +205,7 @@ The **Usage** column explains why each metric is important to visualize and how
{% assign category = layer[0].categories | where_exp: "c", "c.name == category_name" %}
{% assign essential_metrics = category[0].metrics | where: "essential", true %}

{% if include.deployment == 'self-hosted' %}
## Table Statistics

<table markdown="1">
Expand All @@ -193,6 +221,7 @@ The **Usage** column explains why each metric is important to visualize and how

{% for metric in essential_metrics %}
{% if metric.name contains "create_stats" %}

{% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}

<tr>
Expand All @@ -206,11 +235,12 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endif %}
{% endif %}{% comment %}if metric.name contains "create_stats"{% endcomment %}
{% endfor %}

</tbody>
</table>
{% endif %}{% comment %}if include.deployment == 'self-hosted' {% endcomment %}

## Disaster Recovery

Expand All @@ -227,7 +257,16 @@ The **Usage** column explains why each metric is important to visualize and how

{% for metric in essential_metrics %}
{% if metric.name contains "backup" or metric.name contains "BACKUP" %}

{% comment %} For advanced deployment, only show metrics that exist in export YAML files {% endcomment %}
{% assign metric_normalized = metric.name | replace: ".", "_" | replace: "-", "_" %}
{% assign show_metric = false %}
{% if include.deployment == 'self-hosted' %}
{% assign show_metric = true %}
{% elsif advanced_allowed_metrics contains metric_normalized %}
{% assign show_metric = true %}
{% endif %}

{% if show_metric %}
{% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}

<tr>
Expand All @@ -241,7 +280,8 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endif %}
{% endif %}{% comment %}if show_metric{% endcomment %}
{% endif %}{% comment %}if metric.name contains "backup" or metric.name contains "BACKUP"{% endcomment %}
{% endfor %}

</tbody>
Expand Down Expand Up @@ -296,4 +336,4 @@ The **Usage** column explains why each metric is important to visualize and how
- [Visualize metrics in Grafana]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}#step-5-visualize-metrics-in-grafana)
- [Custom Chart Debug Page]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %})
- [Cluster API]({% link {{ page.version.version }}/cluster-api.md %})
- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %})
- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %})
56 changes: 48 additions & 8 deletions src/current/_includes/v26.1/essential-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,24 @@ These essential CockroachDB metrics let you monitor your CockroachDB {{ site.dat
{% assign metrics_datadog = site.data[version].metrics.datadog-crdb-dedicated %}
{% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroach-cloud/#metrics" %}
{% 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 %}
{% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,CROSS_CLUSTER_REPLICATION,UNSET," %}

{% comment %} Build list of allowed metrics from export YAML files {% endcomment %}
{% assign crdb_metrics = site.data[version].metrics.export.crdb_metrics.metrics %}
{% assign shared_metrics = site.data[version].metrics.export.shared_metrics.metrics %}

{% comment %} Extract metric names into a combined string for lookup {% endcomment %}
{% assign advanced_allowed_metrics = "|" %}
{% for metric_pair in crdb_metrics %}
{% assign metric_name = metric_pair[0] %}
{% assign advanced_allowed_metrics = advanced_allowed_metrics | append: metric_name | append: "|" %}
{% endfor %}
{% for metric_pair in shared_metrics %}
{% assign metric_name = metric_pair[0] %}
{% assign advanced_allowed_metrics = advanced_allowed_metrics | append: metric_name | append: "|" %}
{% endfor %}
{% comment %}DEBUG: advanced_allowed_metrics length = {{ advanced_allowed_metrics | size }}{% endcomment %}

These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.advanced }} cluster. Use them to build custom dashboards with the following tools:

Expand Down Expand Up @@ -122,7 +138,17 @@ The **Usage** column explains why each metric is important to visualize and how
{% for metric in essential_metrics %}
{% comment %} STEP 4d. Exclude SQL metrics that will be placed in special categories {% endcomment %}
{% unless category_name == SQL %}
{% unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats" %}
{% comment %} For advanced deployment, only show metrics that exist in export YAML files {% endcomment %}
{% assign metric_normalized = metric.name | replace: ".", "_" | replace: "-", "_" %}
{% assign show_metric = false %}
{% if include.deployment == 'self-hosted' %}
{% assign show_metric = true %}
{% elsif advanced_allowed_metrics contains metric_normalized %}
{% assign show_metric = true %}
{% endif %}

{% if show_metric %}
{% unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats" %}

{% comment %} Transforms to match datadog_id {% endcomment %}
{% assign input_metric = metric.name %}
Expand Down Expand Up @@ -162,7 +188,8 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endunless %}{% comment %}unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats"{% endcomment %}
{% endunless %}{% comment %}unless metric.name contains "backup" or metric.name contains "BACKUP" or metric.name contains "create_stats"{% endcomment %}
{% endif %}{% comment %}if show_metric{% endcomment %}
{% endunless %}{% comment %}unless category_name == SQL{% endcomment %}
{% endfor %}{% comment %}for metric in essential_metrics{% endcomment %}
{% endfor %}{% comment %}for layer in layer_names_array{% endcomment %}
Expand All @@ -178,6 +205,7 @@ The **Usage** column explains why each metric is important to visualize and how
{% assign category = layer[0].categories | where_exp: "c", "c.name == category_name" %}
{% assign essential_metrics = category[0].metrics | where: "essential", true %}

{% if include.deployment == 'self-hosted' %}
## Table Statistics

<table markdown="1">
Expand All @@ -193,6 +221,7 @@ The **Usage** column explains why each metric is important to visualize and how

{% for metric in essential_metrics %}
{% if metric.name contains "create_stats" %}

{% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}

<tr>
Expand All @@ -206,11 +235,12 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endif %}
{% endif %}{% comment %}if metric.name contains "create_stats"{% endcomment %}
{% endfor %}

</tbody>
</table>
{% endif %}{% comment %}if include.deployment == 'self-hosted' {% endcomment %}

## Disaster Recovery

Expand All @@ -227,7 +257,16 @@ The **Usage** column explains why each metric is important to visualize and how

{% for metric in essential_metrics %}
{% if metric.name contains "backup" or metric.name contains "BACKUP" %}

{% comment %} For advanced deployment, only show metrics that exist in export YAML files {% endcomment %}
{% assign metric_normalized = metric.name | replace: ".", "_" | replace: "-", "_" %}
{% assign show_metric = false %}
{% if include.deployment == 'self-hosted' %}
{% assign show_metric = true %}
{% elsif advanced_allowed_metrics contains metric_normalized %}
{% assign show_metric = true %}
{% endif %}

{% if show_metric %}
{% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}

<tr>
Expand All @@ -241,7 +280,8 @@ The **Usage** column explains why each metric is important to visualize and how
<td>{{ metric.how_to_use }}</td>
</tr>

{% endif %}
{% endif %}{% comment %}if show_metric{% endcomment %}
{% endif %}{% comment %}if metric.name contains "backup" or metric.name contains "BACKUP"{% endcomment %}
{% endfor %}

</tbody>
Expand Down Expand Up @@ -296,4 +336,4 @@ The **Usage** column explains why each metric is important to visualize and how
- [Visualize metrics in Grafana]({% link {{ page.version.version }}/monitor-cockroachdb-with-prometheus.md %}#step-5-visualize-metrics-in-grafana)
- [Custom Chart Debug Page]({% link {{ page.version.version }}/ui-custom-chart-debug-page.md %})
- [Cluster API]({% link {{ page.version.version }}/cluster-api.md %})
- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %})
- [Essential Alerts]({% link {{ page.version.version }}/essential-alerts-self-hosted.md %})
Loading