Skip to content

Commit fb573cb

Browse files
authored
DOC-14270 Product Change- PR #149713 - db-console: change the name of the "Hot Ranges" page to "Top Ranges"
- Renamed “Hot Ranges” to “Top Ranges” and adjusted related references and headings. - ui-hot-ranges-page.md renamed to ui-top-ranges-page.md and added redirect. - Updated all links to point to the new filename.
1 parent e883033 commit fb573cb

File tree

9 files changed

+29
-25
lines changed

9 files changed

+29
-25
lines changed

src/current/_data/redirects.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -521,6 +521,10 @@
521521
sources: ['admin-ui-storage-dashboard.md']
522522
versions: ['v20.2', 'v21.1']
523523

524+
- destination: ui-top-ranges-page.md
525+
sources: ['ui-hot-ranges-page.md']
526+
versions: ['v25.4']
527+
524528
- destination: use-a-local-file-server-for-bulk-operations.md
525529
sources: ['create-a-file-server.md']
526530
versions: ['v20.2', 'v21.1']

src/current/_includes/v25.4/sidebar-data/self-hosted-deployments.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -639,9 +639,9 @@
639639
]
640640
},
641641
{
642-
"title": "Hot Ranges Page",
642+
"title": "Top Ranges Page",
643643
"urls": [
644-
"/${VERSION}/ui-hot-ranges-page.html"
644+
"/${VERSION}/ui-top-ranges-page.html"
645645
]
646646
},
647647
{

src/current/v25.4/critical-log-messages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ toc: true
213213
- **Impact**: May cause higher latencies for operations that need to write to that range.
214214
- **Action**: Identify if the range has a disproportionate amount of load and mitigate appropriately, such as splitting ranges manually or using a hash-sharded index.
215215
- **Related metrics**: NONE
216-
- **See also**: [Hot Ranges page]({% link {{ page.version.version }}/ui-hot-ranges-page.md %})
216+
- **See also**: [Top Ranges page]({% link {{ page.version.version }}/ui-top-ranges-page.md %})
217217

218218
## Data Availability
219219

src/current/v25.4/performance-recipes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This section describes how to use CockroachDB commands and dashboards to identif
3939
</tr>
4040
<tr>
4141
<td><ul>
42-
<li>The <b>Hot Ranges</b> page (DB Console) displays a higher-than-expected QPS for a range.</li>
42+
<li>The <b>Top Ranges</b> page (DB Console) displays a higher-than-expected QPS for a range.</li>
4343
<li>The <b>Key Visualizer</b> (DB Console) shows ranges with much higher-than-average write rates for the cluster.</li>
4444
</ul></td>
4545
<td><ul><li>Your cluster has <a href="{% link {{ page.version.version }}/understand-hotspots.md %}">hotspots</a>.</li></ul></td>
@@ -191,10 +191,10 @@ For a detailed explanation of hotspot causes and mitigation strategies, refer to
191191
#### Indicators that your cluster has hotspots
192192

193193
- The **CPU Percent** graph on the [**Hardware**]({% link {{ page.version.version }}/ui-hardware-dashboard.md %}) and [**Overload**]({% link {{ page.version.version }}/ui-overload-dashboard.md %}) dashboards (DB Console) shows spikes in CPU usage.
194-
- The **Hot Ranges** list on the [**Hot Ranges** page]({% link {{ page.version.version }}/ui-hot-ranges-page.md %}) (DB Console) displays a higher-than-expected QPS for a range.
194+
- The **Top Ranges** list on the [**Top Ranges** page]({% link {{ page.version.version }}/ui-top-ranges-page.md %}) (DB Console) displays a higher-than-expected QPS for a range.
195195
- The [**Key Visualizer**]({% link {{ page.version.version }}/ui-key-visualizer.md %}) (DB Console) shows [ranges with much higher-than-average write rates]({% link {{ page.version.version }}/ui-key-visualizer.md %}#identifying-hotspots) for the cluster.
196196

197-
If you find hotspots, use the [**Range Report**]({% link {{ page.version.version }}/ui-hot-ranges-page.md %}#range-report) and [**Key Visualizer**]({% link {{ page.version.version }}/ui-key-visualizer.md %}) to identify the ranges with excessive traffic. Then take steps to [reduce hotspots](#reduce-hotspots).
197+
If you find hotspots, use the [**Range Report**]({% link {{ page.version.version }}/ui-top-ranges-page.md %}#range-report) and [**Key Visualizer**]({% link {{ page.version.version }}/ui-key-visualizer.md %}) to identify the ranges with excessive traffic. Then take steps to [reduce hotspots](#reduce-hotspots).
198198

199199
#### Reduce hotspots
200200

src/current/v25.4/query-behavior-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ A [*hot node*]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-
329329
- [**Hardware** dashboard]({% link {{ page.version.version }}/ui-hardware-dashboard.md %}#cpu-percent) > **CPU Percent** graph
330330
- [**SQL** dashboard]({% link {{ page.version.version }}/ui-sql-dashboard.md %}#connection-latency-99th-percentile) > **SQL Connections** graph
331331
- [**Hardware** dashboard]({% link {{ page.version.version }}/ui-hardware-dashboard.md %}#disk-ops-in-progress) > **Disk IOPS in Progress** graph
332-
- Open the [**Hot Ranges** page]({% link {{ page.version.version }}/ui-hot-ranges-page.md %}) and check for ranges with significantly higher QPS on any nodes.
332+
- Open the [**Top Ranges** page]({% link {{ page.version.version }}/ui-top-ranges-page.md %}) and check for ranges with significantly higher QPS on any nodes.
333333
334334
#### Solution
335335

src/current/v25.4/ui-key-visualizer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,6 @@ The following image shows the Key Visualizer highlighting a [full-table scan]({%
9898

9999
- [DB Console Overview]({% link {{ page.version.version }}/ui-overview.md %})
100100
- [Troubleshooting Overview]({% link {{ page.version.version }}/troubleshooting-overview.md %})
101-
- [Hot Ranges Page]({% link {{ page.version.version }}/ui-hot-ranges-page.md %})
101+
- [Top Ranges Page]({% link {{ page.version.version }}/ui-top-ranges-page.md %})
102102
- [Reduce Hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}#reduce-hotspots)
103103
- [Support Resources]({% link {{ page.version.version }}/support-resources.md %})

src/current/v25.4/ui-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ DB Console area | System-level privilege | Privileged information
122122
[Transactions]({% link {{ page.version.version }}/ui-transactions-page.md %}) | [`VIEWACTIVITY`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivity) or [`VIEWACTIVITYREDACTED`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivityredacted) | Transactions
123123
[Sessions]({% link {{ page.version.version }}/ui-sessions-page.md %}) | [`VIEWACTIVITY`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivity) or [`VIEWACTIVITYREDACTED`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivityredacted) | Sessions
124124
[Insights]({% link {{ page.version.version }}/ui-insights-page.md %}) | [`VIEWACTIVITY`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivity) or [`VIEWACTIVITYREDACTED`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivityredacted) | Insights
125-
[Hot Ranges]({% link {{ page.version.version }}/ui-hot-ranges-page.md %}) | [`VIEWCLUSTERMETADATA`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewclustermetadata) | Ranges
125+
[Top Ranges]({% link {{ page.version.version }}/ui-top-ranges-page.md %}) | [`VIEWCLUSTERMETADATA`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewclustermetadata) | Ranges
126126
[Jobs]({% link {{ page.version.version }}/ui-jobs-page.md %}) | [`VIEWJOB`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewjob) | Jobs
127127
[Advanced Debug]({% link {{ page.version.version }}/ui-debug-pages.md %}) | [`VIEWDEBUG`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewdebug) | Debugging and profiling endpoints
128128
[Advanced Debug > Problem Ranges]({% link {{ page.version.version }}/ui-debug-pages.md %}#reports) | [`VIEWCLUSTERMETADATA`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewclustermetadata) | Ranges

src/current/v25.4/ui-hot-ranges-page.md renamed to src/current/v25.4/ui-top-ranges-page.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Hot Ranges Page
3-
summary: The Hot Ranges page provides details about ranges receiving a high number of reads or writes.
2+
title: Top Ranges Page
3+
summary: The Top Ranges page provides details about the highest-ranked ranges by metrics such as reads, writes, QPS, and CPU.
44
toc: true
55
docs_area: reference.db_console
66
---
@@ -9,11 +9,11 @@ docs_area: reference.db_console
99
On a secure cluster, this area of the DB Console can only be accessed by users belonging to the [`admin` role]({% link {{ page.version.version }}/security-reference/authorization.md %}#admin-role) or a SQL user with the [`VIEWCLUSTERMETADATA`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewclustermetadata) [system privilege]({% link {{ page.version.version }}/security-reference/authorization.md %}#supported-privileges) (or the legacy `VIEWACTIVITY` or `VIEWACTIVITYREDACTED` [role option]({% link {{ page.version.version }}/security-reference/authorization.md %}#role-options)) defined. The [`VIEWACTIVITY`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivity) or [`VIEWACTIVITYREDACTED`]({% link {{ page.version.version }}/security-reference/authorization.md %}#viewactivityredacted) [system privileges]({% link {{ page.version.version }}/security-reference/authorization.md %}#supported-privileges) **do not** grant access to this page.
1010
{{site.data.alerts.end}}
1111

12-
The **Hot Ranges** page of the DB Console provides details about ranges receiving a high number of reads or writes. These are known as [*hot ranges*]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range).
12+
The **Top Ranges** page of the DB Console provides details about the highest-ranked ranges by metrics such as reads, writes, queries per second (QPS), and CPU. Ranges that rank highly by these measures may indicate [*hot ranges*]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range), but are not necessarily problematic.
1313

1414
When optimizing or troubleshooting statement performance, this page can help you identify nodes, ranges, or tables that are experiencing [hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}).
1515

16-
To view this page, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Hot Ranges** in the left-hand navigation.
16+
To view this page, [access the DB Console]({% link {{ page.version.version }}/ui-overview.md %}#db-console-access) and click **Top Ranges** in the left-hand navigation.
1717

1818
## Select nodes
1919

@@ -23,35 +23,35 @@ Selecting a region, such as `us-east1`, selects all nodes in that region.
2323

2424
In the **Select Nodes** search box, enter numbers to search for specific node IDs. For example, in a cluster with 12 nodes, entering `1` returns checkboxes for node IDs `n1`, `n10`, `n11`, and `n12`.
2525

26-
Click **Apply** to view the [hot ranges list](#hot-ranges-list) for the selected nodes.
26+
Click **Apply** to view the [top ranges list](#top-ranges-list) for the selected nodes.
2727

28-
## Filter hot ranges
28+
## Filter top ranges
2929

30-
After [selecting nodes](#select-nodes), use the **Filter** menu to filter the [hot ranges list](#hot-ranges-list). You can choose to view all hot ranges across a specific table, index, store ID, and one or more databases.
30+
After [selecting nodes](#select-nodes), use the **Filter** menu to filter the [top ranges list](#top-ranges-list). You can choose to view top ranges across a specific table, index, store ID, and one or more databases.
3131

3232
In the **Databases** dropdown list, you can choose to filter by specific databases (optional).
3333

3434
In the **Table** and **Index** search boxes, enter the complete name of a table or index to return results. For example, in the [`movr` database]({% link {{ page.version.version }}/movr.md %}), search for the exact index name `users_pkey` to return results. Entering a partial index name, such as `user` or `users` returns no results.
3535

3636
In the **Store ID** search box, enter numbers to search for specific store IDs. For example, in a cluster with 12 stores, entering `1` returns results for store IDs `1`, `10`, `11`, and `12`.
3737

38-
Click **Apply** to view the filtered [hot ranges list](#hot-ranges-list).
38+
Click **Apply** to view the filtered [top ranges list](#top-ranges-list).
3939

40-
## Hot ranges list
40+
## Top ranges list
4141

42-
The **Hot ranges** list displays the ranges with the highest queries per second (QPS) from each node [`store`]({% link {{ page.version.version }}/architecture/storage-layer.md %}).
42+
The **Top ranges** list displays the ranges with the highest queries per second (QPS) from each node [`store`]({% link {{ page.version.version }}/architecture/storage-layer.md %}).
4343

4444
{{site.data.alerts.callout_info}}
45-
Hot ranges are not necessarily problematic. Some ranges naturally experience higher QPS than others. For example, a range for a frequently accessed table will have a higher QPS.
45+
Top ranges are not necessarily problematic. Some ranges naturally experience higher QPS than others. For example, a range for a frequently accessed table will have a higher QPS.
4646

4747
However, a significant increase in traffic can also indicate a *hotspot* on the range that should be reduced. For more information, refer to [Understand hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range).
4848
{{site.data.alerts.end}}
4949

50-
To view the [Range Report](#range-report) for a hot range, click its range ID.
50+
To view the [Range Report](#range-report) for a top range, click its range ID.
5151

5252
Parameter | Description
5353
----------|------------
54-
Range ID | The ID of the hot range. Click the range ID to view the [Range Report](#range-report) for this range.
54+
Range ID | The ID of the top range. Click the range ID to view the [Range Report](#range-report) for this range.
5555
QPS | The total number of [`SELECT`]({% link {{ page.version.version }}/selection-queries.md %}), [`UPDATE`]({% link {{ page.version.version }}/update.md %}), [`INSERT`]({% link {{ page.version.version }}/insert.md %}), and [`DELETE`]({% link {{ page.version.version }}/delete.md %}) queries executed per second on this range. The per-second rate is averaged over the last 30 minutes.
5656
CPU | The total CPU time per second used in processing this range. The per-second rate is averaged over the last 30 minutes.
5757
Write (keys) | The total number of keys written per second on this range. The per-second rate is averaged over the last 30 minutes.
@@ -73,10 +73,10 @@ The **Range Report** is typically used for [advanced debugging]({% link {{ page.
7373
If your aim is to [reduce hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}#reduce-hotspots), refer to the following fields:
7474

7575
- `Key Range` shows the interval of the [key space]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-descriptors) that is "hottest" (i.e., read by the processor). This is expressed as a span of key values.
76-
- `Lease Holder QPS` shows the queries executed per second on the node that holds the [range lease]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leases). If a hot range is not properly using [load-based splitting]({% link {{ page.version.version }}/load-based-splitting.md %}), this will be greater than the value configured by the `kv.range_split.load_qps_threshold` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) (`2500` by default).
76+
- `Lease Holder QPS` shows the queries executed per second on the node that holds the [range lease]({% link {{ page.version.version }}/architecture/replication-layer.md %}#leases). If a top range is not properly using [load-based splitting]({% link {{ page.version.version }}/load-based-splitting.md %}), this will be greater than the value configured by the `kv.range_split.load_qps_threshold` [cluster setting]({% link {{ page.version.version }}/cluster-settings.md %}) (`2500` by default).
7777

7878
## See also
7979

8080
- [Understand Hotspots]({% link {{ page.version.version }}/understand-hotspots.md %})
8181
- [Hash-sharded Indexes]({% link {{ page.version.version }}/hash-sharded-indexes.md %})
82-
- [Architecture Overview]({% link {{ page.version.version }}/architecture/overview.md %})
82+
- [Architecture Overview]({% link {{ page.version.version }}/architecture/overview.md %})

src/current/v25.4/understand-hotspots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The following image is a graph of [CPU Percent]({% link {{ page.version.version
4141

4242
**Synonyms:** range hotspot
4343

44-
A _hot range_ is one level down from the node hotspot. [Ranges]({% link {{ page.version.version }}/architecture/overview.md %}#range) are the smallest unit of data distribution, making them critical in troubleshooting hotspots. The [DB Console Hot Ranges page]({% link {{ page.version.version }}/ui-hot-ranges-page.md %}) provides details about ranges receiving a high number of reads or writes, which become an issue if they cause a [hot node](#hot-node).
44+
A _hot range_ is one level down from the node hotspot. [Ranges]({% link {{ page.version.version }}/architecture/overview.md %}#range) are the smallest unit of data distribution, making them critical in troubleshooting hotspots. The [DB Console Top Ranges page]({% link {{ page.version.version }}/ui-top-ranges-page.md %}) provides details about ranges receiving a high number of reads or writes, which become an issue if they cause a [hot node](#hot-node).
4545

4646
A hot node is often caused by a single hot range. The system may split the hot range to redistribute the load ([load-based splitting]({% link {{ page.version.version }}/load-based-splitting.md %})) or the range may stay hot until it fills up and splits ([range size splitting]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits)). In the second case, the split is likely the continuation of the hotspot (as shown in the [previous image for a hot node](#hotspots-figure-1)). If the system is unable to identify a good splitting point for a hot range (for example, in the case of a [row hotspot](#row-hotspot)), the hot range becomes a bottleneck.
4747

0 commit comments

Comments
 (0)