(1) Updated cloud Metrics page, added Custom Metrics Chart section an…

…d removed link to Available metrics. (2) Added cloud Custom Metrics Chart page which includes metric-names-serverless.md and ui-custom-metrics-chart-page.html and has images. (3) Added metric-names-serverless.md based on cockroachlabs/managed-service PR 14438. (4) Added ui-custom-metrics-chart-page.html based on v23.1/ui-custom-chart-debug-page-00.html. (5) Updated Cloud Deployments sidebar, added Custom Metrics Chart Page link. (6) Patched Preview include. (7) Added cloud release note.
cockroachdb · Sep 29, 2023 · 9f0b9e2 · 9f0b9e2
1 parent a132122
commit 9f0b9e2
Show file tree

Hide file tree

Showing 13 changed files with 189 additions and 5 deletions.
diff --git a/src/current/_data/cloud_releases.csv b/src/current/_data/cloud_releases.csv
@@ -66,3 +66,4 @@ date,sha
 2023-09-11,null
 2023-09-22,null
 2023-09-27,null
+2023-10-02,null
diff --git a/src/current/_includes/cockroachcloud/metric-names-serverless.md b/src/current/_includes/cockroachcloud/metric-names-serverless.md
@@ -0,0 +1,35 @@
+The following is a list of available metrics for use in the Custom Metrics Chart page.
+
+### Changefeed 
+
+Name | Description
+-----|-----
+`changefeed.running` | Number of currently running changefeeds, including sinkless
+`changefeed.failures` | Total number of changefeed jobs which have failed
+`changefeed.error_retries` | Total retryable errors encountered by all changefeeds
+`changefeed.emitted_messages` | Messages emitted by all feeds
+`changefeed.emitted_bytes` | Bytes emitted by all feeds
+`changefeed.commit_latency` | Event commit latency: a difference between event MVCC timestamp and the time it was acknowledged by the downstream sink.  If the sink batches events,  then the difference between the earliest event in the batch and acknowledgement is recorded; Excludes latency during backfill
+`jobs.changefeed.currently_paused` | Number of changefeed jobs currently considered Paused
+`jobs.changefeed.protected_age_sec` | The age of the oldest PTS record protected by changefeed jobs.
+
+### Row-Level TTL
+
+Name | Description
+-----|-----
+`jobs.row_level_ttl.resume_completed` | Number of row_level_ttl jobs which successfully resumed to completion
+`jobs.row_level_ttl.resume_failed` | Number of row_level_ttl jobs which failed with a non-retryable error
+`jobs_row_level_ttl.rows_selected` | Number of rows selected for deletion by the row level TTL job.
+`jobs.row_level_ttl.rows_deleted` | Number of rows deleted by the row level TTL job.
+`jobs.row_level_ttl.currently_paused` | Number of row_level_ttl jobs currently considered Paused
+`jobs.row_level_ttl.currently_running` | Number of row_level_ttl jobs currently running
+`schedules.scheduled-row-level-ttl-executor.failed` | Number of scheduled-row-level-ttl-executor jobs failed
+
+### Table Statistics 
+
+Name | Description
+-----|-----
+`jobs.auto_create_stats.resume_failed` | Number of auto_create_stats jobs which failed with a non-retryable error
+`jobs.auto_create_stats.currently_running` | Number of auto_create_stats jobs currently running
+`jobs.auto_create_stats.currently_paused` | Number of auto_create_stats jobs currently considered Paused
+`jobs.create_stats.currently_running` | Number of create_stats jobs currently running
diff --git a/src/current/_includes/cockroachcloud/ui-custom-metrics-chart-page.html b/src/current/_includes/cockroachcloud/ui-custom-metrics-chart-page.html
@@ -0,0 +1,80 @@
+<table>
+  <thead>
+    <tr>
+      <th>
+        Column
+      </th>
+      <th>
+        Description
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+        Metric
+      </td>
+      <td>
+        How the system refers to this metric, for example, <code>jobs.row_level_ttl.rows_deleted</code>.
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Aggregator
+      </td>
+      <td>
+        <p>
+          Used to combine data points.
+        </p>
+        <p>
+          Options:
+          <ul>
+            <li><strong>Sum</strong>: Returns the sum of all values seen.</li>
+            <li><strong>Max</strong>: Returns the highest value seen.</li>
+            <li><strong>Min</strong>: Returns the lowest value seen.</li>
+            <li><strong>Avg</strong>: Returns the average value over the time period.</li>
+          </ul>
+        </p>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        Rate
+      </td>
+      <td>
+        <p>
+          Determines how to display the rate of change during the selected time period.
+        </p>
+        <p>
+          Option:
+
+          <ul>
+            <li>
+              <strong>Normal</strong>: Returns the actual recorded value.
+            </li>
+          </ul>
+        </p>
+      </td>
+    </tr>
+    <tr>
+      <th>
+        Units
+      </th>
+      <td>
+        <p>
+          Sets the units to display. The selected measurement filters what metrics are available to be added to the chart.
+        </p>
+        <p>
+          Options:
+          <ul>
+            <li><strong>Bytes</strong></li>
+            <li><strong>Count</strong></li>
+            <li><strong>Duration</strong></li>
+            <li><strong>Percentage</strong></li>
+            <li><strong>USD</strong></li>
+          </ul>
+        </p>
+      </td>
+    </tr>
+  </tbody>
+</table>
diff --git a/src/current/_includes/feature-phases/preview.md b/src/current/_includes/feature-phases/preview.md
@@ -1,5 +1,5 @@
-{% if page.cloud == true %}
-  {% capture link_prefix %}../{{site.versions["stable"]}}/{% endcapture %}
+{% if page.path contains "cockroachcloud/" or site.baseurl contains "/cockroachcloud" %}
+  {% capture link_prefix %}../{{site.current_cloud_version}}/{% endcapture %}
 {% elsif page.security == true %}
   {% capture link_prefix %}../{% endcapture %}
 {% else %}

diff --git a/src/current/_includes/releases/cloud/2023-10-02.md b/src/current/_includes/releases/cloud/2023-10-02.md
@@ -0,0 +1,5 @@
+## October 2, 2023
+
+<h3 id="2023-10-02-console-changes"> Console changes </h3>
+
+- CockroachDB {{ site.data.products.serverless }} clusters now have a [**Custom Metrics Chart** page]({% link cockroachcloud/custom-metrics-chart-page.md %}) available in [preview]({% link {{site.current_cloud_version}}/cockroachdb-feature-availability.md %}). From the [**Metrics** page](https://www.cockroachlabs.com/cockroachcloud/metrics-page) in the Console, navigate to the **Custom** tab to create custom charts showing the time series data for an available metric or combination of metrics.
diff --git a/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json
@@ -338,6 +338,12 @@
                       "/cockroachcloud/metrics-page.html"
                     ]
                   },
+                  {
+                    "title": "Custom Metrics Chart Page",
+                    "urls": [
+                      "/cockroachcloud/custom-metrics-chart-page.html"
+                    ]
+                  },
                   {
                     "title": "SQL Activity Page",
                         "items": [

diff --git a/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json b/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json
@@ -338,6 +338,12 @@
                       "/cockroachcloud/metrics-page.html"
                     ]
                   },
+                  {
+                    "title": "Custom Metrics Chart Page",
+                    "urls": [
+                      "/cockroachcloud/custom-metrics-chart-page.html"
+                    ]
+                  },
                   {
                     "title": "SQL Activity Page",
                         "items": [

diff --git a/src/current/cockroachcloud/custom-metrics-chart-page.md b/src/current/cockroachcloud/custom-metrics-chart-page.md
@@ -0,0 +1,42 @@
+---
+title: Custom Metrics Chart Page
+summary: The Custom Metrics Chart page lets you create custom charts showing the time series data for an available metric or combination of metrics.
+toc: true
+---
+
+The **Custom Metrics Chart** page is available only for CockroachDB {{ site.data.products.serverless }} clusters. To view this page, select a cluster from the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page), and click **Metrics** in the **Monitoring** section of the left side navigation. Navigate to the **Custom** tab to create custom charts showing the time series data for an available metric or combination of metrics.
+
+{{site.data.alerts.callout_info}}
+{% include_cached feature-phases/preview.md %}
+{{site.data.alerts.end}}
+
+## Use the Custom Metrics Chart page
+
+<img src="{{ 'images/cockroachcloud/custom-metrics-chart.png' | relative_url }}" alt="Custom Metrics Chart" style="border:1px solid #eee;max-width:100%" />
+
+On the **Custom Metrics Chart** page, you can set the time range for all charts, add new custom charts, and customize each chart:
+
+- To set the time range for the page, use the time interval selector at the top right of the page to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected for all charts on all tabs of the [**Metrics** page]({% link cockroachcloud/metrics-page.md %}).
+- To add a chart, click **Create** to create the first custom chart or **Add Chart** to create subsequent custom charts. The [**Create custom chart** dialog](#create-custom-chart-dialog) is displayed.
+- To edit a chart, click the pencil icon to display the [**Edit custom chart** dialog](#create-custom-chart-dialog).
+- To delete a chart, click the trash icon.
+
+## Create custom chart dialog
+
+In the **Create custom chart** dialog, you can customize each chart.
+
+<img src="{{ 'images/cockroachcloud/custom-metrics-chart-create.png' | relative_url }}" alt="Create Custom Chart" style="border:1px solid #eee;max-width:70%" />
+
+- Under **Select metrics**, add the metrics to be queried, and how they'll be combined and displayed. Options include:
+{% include cockroachcloud/ui-custom-metrics-chart-page.html %}
+- Under **Provide a chart name**, enter title text or keep default title with names of selected metrics.
+- The **Preview** shows data, if available, for the selected metrics in the time range set by the **Metrics** page's time interval selector.
+- Once the chart is verified in the **Preview**, click **Submit** to add the new custom chart or click **Close** to return to the existing **Custom Metrics Chart** page.
+
+## Available metrics
+
+{% include cockroachcloud/metric-names-serverless.md %}
+
+## See also
+
+- [Metrics Page]({% link cockroachcloud/metrics-page.md %})
diff --git a/src/current/cockroachcloud/metrics-page.md b/src/current/cockroachcloud/metrics-page.md
@@ -9,7 +9,7 @@ The **Metrics** page is available for CockroachDB {{ site.data.products.serverle
 
 - [**Monitor SQL Activity**](#monitor-sql-activity)
 - [**Identify SQL Problems**](#identify-sql-problems)
-- [Create **Custom** charts](#create-custom-charts)
+- [Create **Custom** metrics charts](#create-custom-metrics-charts)
 
 ## Time interval selection
 
@@ -77,13 +77,14 @@ This graph shows a moving average of the number of SQL statements that experienc
 
 See the [Statements page]({% link cockroachcloud/statements-page.md %}) for more details on the cluster's SQL statements.
 
-## Create Custom charts
+## Create Custom metrics charts
 
+On the **Custom** tab, you can create one or multiple custom charts showing the time series data for an available metric or combination of metrics.
 
+See the [Custom Metrics Chart page]({% link cockroachcloud/custom-metrics-chart-page.md %}) for more details.
 
 ## See also
 
-- [Available metrics](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/ui-custom-chart-debug-page?filters=metric-names-serverless#available-metrics)
 - [Statements Page]({% link cockroachcloud/statements-page.md %})
 - [Transactions Page]({% link cockroachcloud/transactions-page.md %})
 - [Sessions Page]({% link cockroachcloud/sessions-page.md %})

diff --git a/src/current/images/cockroachcloud/custom-metrics-chart-create.png b/src/current/images/cockroachcloud/custom-metrics-chart-create.png
diff --git a/src/current/images/cockroachcloud/custom-metrics-chart.png b/src/current/images/cockroachcloud/custom-metrics-chart.png
diff --git a/src/current/v23.1/cockroachdb-feature-availability.md b/src/current/v23.1/cockroachdb-feature-availability.md
@@ -36,6 +36,10 @@ Command                                     | Description
 [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %})     | Start a temporary, in-memory CockroachDB cluster, and open an interactive SQL shell to it.
 [`cockroach sqlfmt`]({% link {{ page.version.version }}/cockroach-sqlfmt.md %}) | Reformat SQL queries for enhanced clarity.
 
+### Custom Metric Chart page for CockroachDB {{ site.data.products.serverless }} clusters
+
+The [**Custom Metric Chart** page]({% link cockroachcloud/custom-metrics-chart-page.md %}) for CockroachDB {{ site.data.products.serverless }} clusters allows you to create custom charts showing the time series data for an available metric or combination of metrics.
+
 ### Log SQL Statistics to Datadog
 
 Configure [logging of `sampled_query` events to Datadog]({% link {{ page.version.version }}/log-sql-statistics-to-datadog.md %}) for finer granularity and long-term retention of SQL statistics. The [`sampled_query` events]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) contain common SQL event and execution details for sessions, transactions, and statements.

diff --git a/src/current/v23.2/cockroachdb-feature-availability.md b/src/current/v23.2/cockroachdb-feature-availability.md
@@ -36,6 +36,10 @@ Command                                     | Description
 [`cockroach demo`]({% link {{ page.version.version }}/cockroach-demo.md %})     | Start a temporary, in-memory CockroachDB cluster, and open an interactive SQL shell to it.
 [`cockroach sqlfmt`]({% link {{ page.version.version }}/cockroach-sqlfmt.md %}) | Reformat SQL queries for enhanced clarity.
 
+### Custom Metric Chart page for CockroachDB {{ site.data.products.serverless }} clusters
+
+The [**Custom Metric Chart** page]({% link cockroachcloud/custom-metrics-chart-page.md %}#) for CockroachDB {{ site.data.products.serverless }} clusters allows you to create custom charts showing the time series data for an available metric or combination of metrics.
+
 ### Log SQL Statistics to Datadog
 
 Configure [logging of `sampled_query` events to Datadog]({% link {{ page.version.version }}/log-sql-statistics-to-datadog.md %}) for finer granularity and long-term retention of SQL statistics. The [`sampled_query` events]({% link {{ page.version.version }}/eventlog.md %}#sampled_query) contain common SQL event and execution details for sessions, transactions, and statements.