Skip to content

Commit a019b54

Browse files
author
github-actions
committed
update MD by dispatch event pingcap/docs feature/preview-top-navigation
1 parent 8f1170b commit a019b54

16 files changed

+357
-39
lines changed

markdown-pages/en/tidb/release-8.5/best-practices/pd-scheduling-best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ Practically, if a node failure is considered unrecoverable, you can immediately
297297

298298
Starting from TiDB v5.2.0, TiKV introduces a mechanism to detect slow-disk nodes. By sampling the requests in TiKV, this mechanism works out a score ranging from 1 to 100. A TiKV node with a score higher than or equal to 80 is marked as slow. You can add [`evict-slow-store-scheduler`](/pd-control.md#scheduler-show--add--remove--pause--resume--config--describe) to schedule slow nodes. If only one TiKV node is detected as slow, and its slow score reaches the limit (80 by default), the Leaders on that node will be evicted (similar to the effect of `evict-leader-scheduler`).
299299

300-
Starting from v8.5.5, TiKV introduces a mechanism to detect slow-network nodes. Similar to slow-disk node detection, this mechanism identifies slow nodes by probing network latency between TiKV nodes and calculating a score. You can enable this mechanism using [`enable-network-slow-store`](/pd-control.md#scheduler-config-evict-slow-store-scheduler).
300+
Starting from v8.5.5, TiKV introduces a mechanism to detect slow-network nodes. Similar to slow-disk node detection, this mechanism identifies slow nodes by probing network latency between TiKV nodes and calculating a score. You can enable this mechanism using [`enable-network-slow-store`](/pd-control.md#scheduler-config-evict-slow-store-scheduler) (disabled by default).
301301

302302
> **Note:**
303303
>

markdown-pages/en/tidb/release-8.5/pd-control.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -978,16 +978,14 @@ For slow-disk nodes, the detection on TiKV and the scheduling via `evict-slow-st
978978
979979
Starting from v8.5.5, TiKV supports reporting a `NetworkSlowScore` in store heartbeats to PD. It is calculated based on network detection results and helps identify slow nodes experiencing network jitter. The score ranges from 1 to 100, where a higher value indicates a higher possibility of network anomalies.
980980
981-
For compatibility and resource consumption considerations, the detection and scheduling of slow-network nodes are disabled by default. To enable them, configure both of the following:
981+
- TiKV enables detection of slow-network nodes by default, with a default probing interval of `100ms`. To modify the probing frequency, set the TiKV configuration item [`raftstore.inspect-network-interval`](/tikv-configuration-file.md#inspect-network-interval-new-in-v855) to an appropriate value. A smaller value increases the probing frequency, which helps detect network jitter more quickly, but also consumes more network and CPU resources.
982982
983-
1. Enable the PD scheduler to handle slow-network nodes:
983+
- Scheduling for slow-network nodes is disabled by default on the PD side. To enable it, configure PD as follows:
984984
985985
```bash
986986
scheduler config evict-slow-store-scheduler set enable-network-slow-store true
987987
```
988988
989-
2. On TiKV, set the [`raftstore.inspect-network-interval`](/tikv-configuration-file.md#inspect-network-interval-new-in-v855) configuration item to a value greater than `0` to enable network detection.
990-
991989
#### Recovery time control
992990
993991
You can specify how long a slow node must remain stable before it is considered recovered by using the `recovery-duration` parameter.

markdown-pages/en/tidb/release-8.5/releases/release-8.5.5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Quick access: [Quick start](https://docs.pingcap.com/tidb/v8.5/quick-start-with-
4747

4848
To explicitly instruct the optimizer to push index lookups down to TiKV for a specific table, you can use the [`INDEX_LOOKUP_PUSHDOWN(t1_name, idx1_name [, idx2_name ...])`](https://docs.pingcap.com/tidb/v8.5/optimizer-hints#index_lookup_pushdownt1_name-idx1_name--idx2_name--new-in-v855) hint. It is recommended to combine this hint with the table's AFFINITY attribute. For example, set `AFFINITY="table"` for regular tables and `AFFINITY="partition"` for partitioned tables.
4949

50-
To disable index lookup pushdown to TiKV for a specific table, use the [`NO_INDEX_LOOKUP_PUSHDOWN(t1_name)`](https://docs.pingcap.com/tidb/v8.5/optimizer-hints#no_index_lookup_pushdownt1_name--new-in-v855) hint.
50+
To disable index lookup pushdown to TiKV for a specific table, use the [`NO_INDEX_LOOKUP_PUSHDOWN(t1_name)`](https://docs.pingcap.com/tidb/v8.5/optimizer-hints#no_index_lookup_pushdownt1_name-new-in-v855) hint.
5151

5252
For more information, see [documentation](https://docs.pingcap.com/tidb/v8.5/optimizer-hints#index_lookup_pushdownt1_name-idx1_name--idx2_name--new-in-v855).
5353

markdown-pages/en/tidbcloud/master/TOC-tidb-cloud-essential.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@
5757
- Monitor and Alert
5858
- [Overview](/tidb-cloud/monitor-tidb-cluster.md)
5959
- [Built-in Metrics](/tidb-cloud/built-in-monitoring.md)
60+
- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md)
61+
- Subscribe to Alert Notifications
62+
- [Subscribe via Email](/tidb-cloud/monitor-alert-email.md)
63+
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
64+
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
6065
- [Cluster Events](/tidb-cloud/tidb-cloud-events.md)
6166
- Tune Performance
6267
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
@@ -550,6 +555,11 @@
550555
- [Connected Care Details](/tidb-cloud/connected-care-detail.md)
551556
- Connected Care Support Service Features
552557
- [Connected: AI Chat in IM](/tidb-cloud/connected-ai-chat-in-im.md)
558+
- Connected: IM Subscription for TiDB Cloud Alerts
559+
- [Subscribe via Slack](/tidb-cloud/monitor-alert-slack.md)
560+
- [Subscribe via Zoom](/tidb-cloud/monitor-alert-zoom.md)
561+
- [Subscribe via Flashduty](/tidb-cloud/monitor-alert-flashduty.md)
562+
- [Subscribe via PagerDuty](/tidb-cloud/monitor-alert-pagerduty.md)
553563
- Connected: IM Ticket Creation and Update Subscription
554564
- [Create Tickets and Subscribe to Ticket Updates via Slack](/tidb-cloud/connected-slack-ticket-creation.md)
555565
- [Create Tickets and Subscribe to Ticket Updates via Lark](/tidb-cloud/connected-lark-ticket-creation.md)

markdown-pages/en/tidbcloud/master/tidb-cloud/import-csv-files.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,12 +194,32 @@ To import the CSV files to TiDB Cloud, take the following steps:
194194
195195
- **Included Schema Files**: if the source folder contains the target table schema files (such as `${db_name}-schema-create.sql`), select **Yes**. Otherwise, select **No**.
196196
- **Data Format**: select **CSV**.
197+
- **Connectivity Method**: select how TiDB Cloud connects to your Azure Blob Storage:
198+
199+
- **Public** (default): connects over the public internet. Use this option when the storage account allows public network access.
200+
- **Private Link**: connects through an Azure private endpoint for network-isolated access. Use this option when the storage account blocks public access or when your security policy requires private connectivity. If you select **Private Link**, you also need to fill in the additional field **Azure Blob Storage Resource ID**. To find the resource ID:
201+
202+
1. Go to the [Azure portal](https://portal.azure.com/).
203+
2. Navigate to your storage account and click **Overview** > **JSON View**.
204+
3. Copy the value of the `id` property. The resource ID is in the format `/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Storage/storageAccounts/<account_name>`.
205+
197206
- **Edit CSV Configuration**: if necessary, configure the options according to your CSV files. You can set the separator and delimiter characters, specify whether to use backslashes for escaped characters, and specify whether your files contain a header row.
198207
- **Folder URI**: enter the Azure Blob Storage URI where your source files are located using the format `https://[account_name].blob.core.windows.net/[container_name]/[data_source_folder]/`. The path must end with a `/`. For example, `https://myaccount.blob.core.windows.net/mycontainer/myfolder/`.
199208
- **SAS Token**: enter an account SAS token to allow TiDB Cloud to access the source files in your Azure Blob Storage container. If you don't have one yet, you can create it using the provided Azure ARM template by clicking **Click here to create a new one with Azure ARM template** and following the instructions on the screen. Alternatively, you can manually create an account SAS token. For more information, see [Configure Azure Blob Storage access](/tidb-cloud/dedicated-external-storage.md#configure-azure-blob-storage-access).
200209

201210
4. Click **Connect**.
202211

212+
If you selected **Private Link** as the connectivity method, TiDB Cloud creates a private endpoint for your storage account. You need to approve this endpoint request in the Azure portal before the connection can proceed:
213+
214+
1. Go to the [Azure portal](https://portal.azure.com/) and navigate to your storage account.
215+
2. Click **Networking** > **Private endpoint connections**.
216+
3. Find the pending connection request from TiDB Cloud and click **Approve**.
217+
4. Return to the [TiDB Cloud console](https://tidbcloud.com/). The import wizard proceeds automatically once the endpoint is approved.
218+
219+
> **Note:**
220+
>
221+
> If the endpoint is not yet approved, TiDB Cloud displays a message indicating that the connection is pending approval. Approve the request in the [Azure portal](https://portal.azure.com/) and retry the connection.
222+
203223
5. In the **Destination** section, select the target database and table.
204224

205225
When importing multiple files, you can use **Advanced Settings** > **Mapping Settings** to customize the mapping of individual target tables to their corresponding CSV files. For each target database and table:

markdown-pages/en/tidbcloud/master/tidb-cloud/import-parquet-files.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,11 +198,31 @@ To import the Parquet files to TiDB Cloud, take the following steps:
198198
199199
- **Included Schema Files**: if the source folder contains the target table schema files (such as `${db_name}-schema-create.sql`), select **Yes**. Otherwise, select **No**.
200200
- **Data Format**: select **Parquet**.
201+
- **Connectivity Method**: select how TiDB Cloud connects to your Azure Blob Storage:
202+
203+
- **Public** (default): connects over the public internet. Use this option when the storage account allows public network access.
204+
- **Private Link**: connects through an Azure private endpoint for network-isolated access. Use this option when the storage account blocks public access or when your security policy requires private connectivity. If you select **Private Link**, you also need to fill in the additional field **Azure Blob Storage Resource ID**. To find the resource ID:
205+
206+
1. Go to the [Azure portal](https://portal.azure.com/).
207+
2. Navigate to your storage account and click **Overview** > **JSON View**.
208+
3. Copy the value of the `id` property. The resource ID is in the format `/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Storage/storageAccounts/<account_name>`.
209+
201210
- **Folder URI**: enter the Azure Blob Storage URI where your source files are located using the format `https://[account_name].blob.core.windows.net/[container_name]/[data_source_folder]/`. The path must end with a `/`. For example, `https://myaccount.blob.core.windows.net/mycontainer/data-ingestion/`.
202211
- **SAS Token**: enter an account SAS token to allow TiDB Cloud to access the source files in your Azure Blob Storage container. If you don't have one yet, you can create it using the provided Azure ARM template by clicking **Click here to create a new one with Azure ARM template** and following the instructions on the screen. Alternatively, you can manually create an account SAS token. For more information, see [Configure Azure Blob Storage access](/tidb-cloud/dedicated-external-storage.md#configure-azure-blob-storage-access).
203212

204213
4. Click **Connect**.
205214

215+
If you selected **Private Link** as the connectivity method, TiDB Cloud creates a private endpoint for your storage account. You need to approve this endpoint request in the Azure portal before the connection can proceed:
216+
217+
1. Go to the [Azure portal](https://portal.azure.com/) and navigate to your storage account.
218+
2. Click **Networking** > **Private endpoint connections**.
219+
3. Find the pending connection request from TiDB Cloud and click **Approve**.
220+
4. Return to the [TiDB Cloud console](https://tidbcloud.com/). The import wizard proceeds automatically once the endpoint is approved.
221+
222+
> **Note:**
223+
>
224+
> If the endpoint is not yet approved, TiDB Cloud displays a message indicating that the connection is pending approval. Approve the request in the [Azure portal](https://portal.azure.com/) and retry the connection.
225+
206226
5. In the **Destination** section, select the target database and table.
207227

208228
When importing multiple files, you can use **Advanced Settings** > **Mapping Settings** to customize the mapping of individual target tables to their corresponding Parquet files. For each target database and table:

markdown-pages/en/tidbcloud/master/tidb-cloud/import-sample-data.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,36 @@ This document describes how to import the sample data (SQL files) into TiDB Clou
7979

8080
- **Included Schema Files**: for the sample data, select **Yes**.
8181
- **Data Format**: select **SQL**.
82+
- **Connectivity Method**: select how TiDB Cloud connects to your Azure Blob Storage. To import the sample data, you can use the default connectivity method.
83+
84+
- **Public** (default): connects over the public internet. Use this option when the storage account allows public network access.
85+
- **Private Link**: connects through an Azure private endpoint for network-isolated access. Use this option when the storage account blocks public access or when your security policy requires private connectivity. If you select **Private Link**, you also need to fill in the additional field **Azure Blob Storage Resource ID**. To find the resource ID:
86+
87+
1. Go to the [Azure portal](https://portal.azure.com/).
88+
2. Navigate to your storage account and click **Overview** > **JSON View**.
89+
3. Copy the value of the `id` property. The resource ID is in the format `/subscriptions/<subscription_id>/resourceGroups/<resource_group>/providers/Microsoft.Storage/storageAccounts/<account_name>`.
90+
8291
- **Folder URI**: enter the sample data URI `https://tcidmsampledata.blob.core.windows.net/sql/`.
8392
- **SAS Token**:
8493
- For the sample data, use the following **SAS Token**: `sv=2015-04-05&ss=b&srt=co&sp=rl&se=2099-03-01T00%3A00%3A01.0000000Z&sig=cQHvaofmVsUJEbgyf4JFkAwTJGsFOmbQHx03GvVMrNc%3D`.
8594
- For your own data, you can use a SAS token to access your Azure Blob Storage. For more information, see [Configure Azure Blob Storage access](/tidb-cloud/dedicated-external-storage.md#configure-azure-blob-storage-access).
8695

8796
If the region of the storage account is different from your cluster, confirm the compliance of cross region.
8897

89-
4. Click **Connect** > **Start Import**.
98+
4. Click **Connect**.
99+
100+
If you selected **Private Link** as the connectivity method, TiDB Cloud creates a private endpoint for your storage account. You need to approve this endpoint request in the Azure portal before the connection can proceed:
101+
102+
1. Go to the [Azure portal](https://portal.azure.com/) and navigate to your storage account.
103+
2. Click **Networking** > **Private endpoint connections**.
104+
3. Find the pending connection request from TiDB Cloud and click **Approve**.
105+
4. Return to the [TiDB Cloud console](https://tidbcloud.com/). The import wizard proceeds automatically once the endpoint is approved.
106+
107+
> **Note:**
108+
>
109+
> If the endpoint is not yet approved, TiDB Cloud displays a message indicating that the connection is pending approval. Approve the request in the [Azure portal](https://portal.azure.com/) and retry the connection.
110+
111+
5. Click **Start Import**.
90112

91113
</div>
92114
</SimpleTab>

markdown-pages/en/tidbcloud/master/tidb-cloud/monitor-alert-email.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,22 @@ TiDB Cloud provides you with an easy way to subscribe to alert notifications via
99

1010
> **Note:**
1111
>
12-
> Currently, alert subscription is only available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
12+
> Currently, alert subscription is available for [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters.
1313
1414
## Prerequisites
1515

1616
- To subscribe to alert notifications of TiDB Cloud, you must have the `Organization Owner` access to your organization or `Project Owner` access to the target project in TiDB Cloud.
1717

1818
## Subscribe to alert notifications
1919

20+
To receive alert notifications, take the following steps. The steps vary by cluster plan.
21+
22+
<CustomContent plan="dedicated">
23+
2024
> **Tip:**
2125
>
2226
> The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once.
2327
24-
To get alert notifications of clusters in your project, take the following steps:
25-
2628
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
2729
2. In the left navigation pane, click **Project Settings** > **Alert Subscription**.
2830
3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner.
@@ -34,16 +36,51 @@ To get alert notifications of clusters in your project, take the following steps
3436
- If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and then retry the connection.
3537

3638
7. Click **Save** to complete the subscription.
39+
40+
</CustomContent>
41+
42+
<CustomContent plan="essential">
43+
44+
> **Tip:**
45+
>
46+
> The alert subscription is for all alerts in the current cluster. If you have multiple clusters, you need to subscribe to each cluster individually.
47+
48+
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster using the combo box in the upper-left corner.
49+
2. In the left navigation pane, click **Settings** > **Alert Subscription**.
50+
3. On the **Alert Subscription** page, click **Add Subscriber** in the upper-right corner.
51+
4. Select **Email** from the **Subscriber Type** drop-down list.
52+
5. Enter your email address.
53+
6. Click **Test Connection**.
54+
55+
- If the test succeeds, the **Save** button is displayed.
56+
- If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and then retry the connection.
57+
58+
7. Click **Save** to complete the subscription.
59+
60+
</CustomContent>
3761

38-
Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the cluster. You will be directed to the **Alert Subscriber** page.
62+
Alternatively, you can also click **Subscribe** in the upper-right corner of the [**Alert**](/tidb-cloud/monitor-built-in-alerting.md#view-alerts) page of the cluster. You will be directed to the **Alert Subscription** page.
3963

4064
If an alert condition remains unchanged, the alert sends email notifications every three hours.
4165

4266
## Unsubscribe from alert notifications
4367

44-
If you no longer want to receive alert notifications of clusters in your project, take the following steps:
68+
If you no longer want to receive alert notifications, please take the following steps. The steps vary by cluster plan.
69+
70+
<CustomContent plan="dedicated">
4571

4672
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target project using the combo box in the upper-left corner.
4773
2. In the left navigation pane, click **Project Settings** > **Alert Subscription**.
4874
3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**.
49-
4. Click **Unsubscribe** to confirm the unsubscription.
75+
4. Click **Unsubscribe** to confirm the unsubscription.
76+
77+
</CustomContent>
78+
79+
<CustomContent plan="essential">
80+
81+
1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target cluster using the combo box in the upper-left corner.
82+
2. In the left navigation pane, click **Settings** > **Alert Subscription**.
83+
3. On the **Alert Subscription** page, locate the row of your target subscriber to be deleted, and then click **...** > **Unsubscribe**.
84+
4. Click **Unsubscribe** to confirm the unsubscription.
85+
86+
</CustomContent>

0 commit comments

Comments
 (0)