In essential-metrics.md, added sections for Table Statistics and Disaster Recovery.

Regenerated metrics.yaml using v25.3.0-beta.1.

Author: florence-crl

src/current/_data/v25.3/metrics/metrics.yaml

@@ -12424,6 +12424,22 @@ layers:
       unit: BYTES
       aggregation: AVG
       derivative: NONE
+    - name: kv.rangefeed.mux_stream_send.latency
+      exported_name: kv_rangefeed_mux_stream_send_latency
+      description: Latency of sending RangeFeed events to the client
+      y_axis_label: Latency
+      type: HISTOGRAM
+      unit: NANOSECONDS
+      aggregation: AVG
+      derivative: NONE
+    - name: kv.rangefeed.mux_stream_send.slow_events
+      exported_name: kv_rangefeed_mux_stream_send_slow_events
+      description: Number of RangeFeed events that took longer than 10s to send to the client
+      y_axis_label: Events
+      type: COUNTER
+      unit: COUNT
+      aggregation: AVG
+      derivative: NON_NEGATIVE_DERIVATIVE
     - name: kv.rangefeed.output_loop_unbuffered_registration_nanos
       exported_name: kv_rangefeed_output_loop_unbuffered_registration_nanos
       description: Duration of the Rangefeed O(range) output loop goroutine. This is only applicable for unbuffered registrations since buffered registrations spawns long-living goroutines.
@@ -15137,6 +15153,14 @@ layers:
       unit: COUNT
       aggregation: AVG
       derivative: NONE
+    - name: replicas.cpunanospersecond
+      exported_name: replicas_cpunanospersecond
+      description: Nanoseconds of CPU time in Replica request processing including evaluation but not replication
+      y_axis_label: Nanoseconds
+      type: COUNTER
+      unit: NANOSECONDS
+      aggregation: AVG
+      derivative: NON_NEGATIVE_DERIVATIVE
     - name: replicas.leaders
       exported_name: replicas_leaders
       description: Number of raft leaders

src/current/_includes/v25.3/essential-metrics.md

@@ -3,7 +3,7 @@
 
 These essential CockroachDB metrics let you monitor your CockroachDB {{ site.data.products.core }} cluster. Use them to build custom dashboards with the following tools:
 
-{% comment %} Assign variables specific to deployment {% endcomment %}
+{% comment %} STEP 1. Assign variables specific to deployment {% endcomment %}
 {% if include.deployment == 'self-hosted' %}
   {% assign metrics_datadog = site.data[version].metrics.datadog-cockroachdb %}
   {% assign datadog_link = "https://docs.datadoghq.com/integrations/cockroachdb/?tab=host#metrics" %}
@@ -17,7 +17,7 @@ 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 {% endcomment %}
+{% comment %} Removed NETWORKING category for advanced deployment {% endcomment %}
   {% assign category_order = "HARDWARE,STORAGE,OVERLOAD,DISTRIBUTED,REPLICATION,SQL,CHANGEFEEDS,TTL,UNSET," %}
 
 - [Datadog integration]({% link cockroachcloud/tools-page.md %}#monitor-cockroachdb-cloud-with-datadog) - The [**Datadog Integration Metric Name**]({{ datadog_link }}) column lists the corresponding Datadog metric which requires the `{{ datadog_prefix }}` prefix.
@@ -29,16 +29,16 @@ The **Usage** column explains why each metric is important to visualize and how
 
 {% assign layers = site.data[version].metrics.metrics.layers %}
 
-{% comment %} Create layer name array {% endcomment %}
+{% comment %} STEP 2. Create array of layer names {% endcomment %}
 {% assign layer_names_string = "" %}
 {% for layer in layers %}
   {% assign layer_names_string = layer_names_string | append: layer.name | append: "," %}
 {% endfor %}
-{% comment %} Order layers {% endcomment %}
+
 {% comment %}DEBUG: layer_names_string = {{ layer_names_string }}{% endcomment %}
 {% assign layer_names_array = layer_names_string | split: "," %}
 
-{% comment %} Create string of unique category names {% endcomment %}
+{% comment %} STEP 3. Create array of unique category names {% endcomment %}
 {% assign category_names_string = "" %}
 {% for layer_name in layer_names_array %}
   {% assign layer = layers | where_exp: "l", "l.name == layer_name" %} 
@@ -60,12 +60,11 @@ The **Usage** column explains why each metric is important to visualize and how
 {% comment %}DEBUG: category_names_string_ordered = {{ category_names_string_ordered }}{% endcomment %}
 {% assign category_names_array = category_names_string_ordered | split: "," %}
 
-{% comment %} Create sections for each unique category. For example, both APPLICATION and STORAGE layers have a SQL category. {% endcomment %}
+{% comment %} STEP 4. Create sections for each unique category. For example, both APPLICATION and STORAGE layers have a SQL category, however only one SQL category will be created. {% endcomment %}
 {% for category_name in category_names_array %}
   {% if category_name != "" %}
 
-    {% comment %} Create sections for each unique category {% endcomment %}
-    {% comment %} Loop 1 to count essential metrics {% endcomment %}
+    {% comment %} STEP 4a. Loop 1 to count essential metrics {% endcomment %}
     {% assign essential_metrics_total = 0 %}
     {% for layer_name in layer_names_array %}
       
@@ -79,9 +78,10 @@ The **Usage** column explains why each metric is important to visualize and how
 
     {% endfor %}{% comment %}for layer in layer_names_array{% endcomment %}
 
-    {% comment %} Only create a section for a category if essential metrics exist. For example, the UNSET category does not have any essential metrics.{% endcomment %}
+    {% comment %} STEP 4b. Only create a section for a category if essential metrics exist. For example, the UNSET category does not have any essential metrics.{% endcomment %}
     {% if essential_metrics_total > 0 %}
 
+      {% comment %} Transform category_name to user-facing name. {% endcomment %}
       {% if category_name == "HARDWARE" %}{% assign category_display_name = "Platform" %}
       {% elsif category_name == "STORAGE" %}{% assign category_display_name = "Storage" %}
       {% elsif category_name == "OVERLOAD" %}{% assign category_display_name = "Health" %}
@@ -107,15 +107,18 @@ The **Usage** column explains why each metric is important to visualize and how
     </thead>
     <tbody>
 
-      {% comment %} Loop 2 to print essential metrics for category{% endcomment %}
+      {% comment %} STEP 4c. Loop 2 to create essential metric rows for category{% endcomment %}
       {% for layer_name in layer_names_array %}
         
-        {% assign layer = layers | where_exp: "l", "l.name == layer_name" %}      
+        {% assign layer = layers | where_exp: "l", "l.name == layer_name" %}
         {% assign category = layer[0].categories | where_exp: "c", "c.name == category_name" %}
         {% assign essential_metrics = category[0].metrics | where: "essential", true %}     
         {% comment %}DEBUG: 1 {{ layer_name }} 2 {{ layer[0].name }} 3 {{ category[0].name }}{% endcomment %} 
 
         {% 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 %} Transforms to match datadog_id {% endcomment %}
           {% assign input_metric = metric.name %}
@@ -154,16 +157,95 @@ 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 category_name == SQL{% endcomment %}
         {% endfor %}{% comment %}for metric in essential_metrics{% endcomment %}
       {% endfor %}{% comment %}for layer in layer_names_array{% endcomment %}
 
     </tbody>
 </table>
+
     {% endif %}{% comment %}essential_metrics_total > 0{% endcomment %}
+
+    {% comment %} STEP 4e. Create SQL special categories {% endcomment %}
+    {% if category_name == "SQL" %}
+      {% assign layer = layers | where_exp: "l", "l.name == 'APPLICATION'" %}
+      {% assign category = layer[0].categories | where_exp: "c", "c.name == category_name" %}
+      {% assign essential_metrics = category[0].metrics | where: "essential", true %}
+
+## Table Statistics
+
+<table markdown="1">
+    <thead>
+        <tr>
+            <th>CockroachDB Metric Name</th>
+            <th>[Datadog Integration Metric Name]({{ datadog_link }})<br>(add `{{ datadog_prefix }}.` prefix)</th>
+            <th>Description</th>
+            <th>Usage</th>
+        </tr>
+    </thead>
+    <tbody>
+
+     {% for metric in essential_metrics %}
+        {% if metric.name contains "create_stats" %}
+          {% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}
+
+        <tr>
+            <td><div id="{{ metric_link }}" class="anchored"><code>{{ metric.name }}</code></div>
+            <br>{% if metric.labeled_name %}<code>metrics</code> endpoint:<br><code>{{ metric.labeled_name }}</code>{% endif %}
+            </td>
+            <td><code>{{ metric.name }}</code>
+            </td>
+            <td>{{ metric.description }}</td>
+            <td>{{ metric.how_to_use }}</td>
+        </tr>
+
+        {% endif %}
+      {% endfor %}
+
+    </tbody>
+</table>
+
+## Disaster Recovery
+
+<table markdown="1">
+    <thead>
+        <tr>
+            <th>CockroachDB Metric Name</th>
+            <th>[Datadog Integration Metric Name]({{ datadog_link }})<br>(add `{{ datadog_prefix }}.` prefix)</th>
+            <th>Description</th>
+            <th>Usage</th>
+        </tr>
+    </thead>
+    <tbody>
+
+     {% for metric in essential_metrics %}
+        {% if metric.name contains "backup" or metric.name contains "BACKUP" %}
+
+          {% assign metric_link = metric.name | replace: "_", "-" | replace: ".", "-" %}
+
+        <tr>
+            <td><div id="{{ metric_link }}" class="anchored"><code>{{ metric.name }}</code></div>
+            <br>{% if metric.labeled_name %}<code>metrics</code> endpoint:<br><code>{{ metric.labeled_name }}</code>{% endif %}
+            </td>
+            <td><code>{{ metric.name }}</code>
+            </td>
+            <td>{{ metric.description }}</td>
+            <td>{{ metric.how_to_use }}</td>
+        </tr>
+
+        {% endif %}
+      {% endfor %}
+
+    </tbody>
+</table>
+
+    {% endif %}{% comment %}if category_name == "SQL"{% endcomment %}
+
   {% endif %}{% comment %}if category_name != ""{% endcomment %}
 {% endfor %}{% comment %}for category_name in category_names_array{% endcomment %}
 
-{% comment %} Add category for metrics that are not in metrics.yaml{% endcomment %}
+{% comment %} STEP 5. Add category for metrics that are not in metrics.yaml{% endcomment %}
 {% if include.deployment == 'self-hosted' %}
   {% assign essential_metrics = site.data[version].metrics.available-metrics-not-in-metrics-list | where: "essential", true %}
 ## Expiration of license and certificates

src/current/v25.3/essential-metrics-self-hosted.md

@@ -4,4 +4,4 @@ summary: Learn about the recommended essential metrics for monitoring your Cockr
 toc: true
 ---
 
-{% include {{ page.version.version }}/essential-metrics.md deployment='self-hosted' %}
+{% include {{ page.version.version }}/essential-metrics.md deployment='self-hosted' %}