Skip to content
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.

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

*: update info on support resources #12356

Merged
merged 12 commits into from
Feb 16, 2023
1 change: 1 addition & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@
- [Identify Expensive Queries Using Top SQL](/dashboard/top-sql.md)
- [Identify Expensive Queries Using Logs](/identify-expensive-queries.md)
- [Save and Restore the On-Site Information of a Cluster](/sql-plan-replayer.md)
- [Support Resources](/support.md)
- Performance Tuning
- Tuning Guide
- [Performance Tuning Overview](/performance-tuning-overview.md)
Expand Down
2 changes: 1 addition & 1 deletion alert-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ This section gives the alert rules for the TiKV component.

1. Perform `SELECT VARIABLE_VALUE FROM mysql.tidb WHERE VARIABLE_NAME = "tikv_gc_leader_desc"` to locate the `tidb-server` corresponding to the GC leader;
2. View the log of the `tidb-server`, and grep gc_worker tidb.log;
3. If you find that the GC worker has been resolving locks (the last log is "start resolve locks") or deleting ranges (the last log is "start delete {number} ranges") during this time, it means the GC process is running normally. Otherwise, contact [support@pingcap.com](mailto:support@pingcap.com) to resolve this issue.
3. If you find that the GC worker has been resolving locks (the last log is "start resolve locks") or deleting ranges (the last log is "start delete {number} ranges") during this time, it means the GC process is running normally. Otherwise, [get support](/support.md) from PingCAP or the community.

### Critical-level alerts

Expand Down
4 changes: 2 additions & 2 deletions clinic/clinic-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ PingCAP Clinic provides the following two components to diagnose cluster problem

- Troubleshoot cluster problems remotely

When your cluster has some problems that cannot be fixed quickly, you can ask for help at [TiDB Community slack channel](https://tidbcommunity.slack.com/archives/CH7TTLL7P) or contact PingCAP technical support. When contacting technical support for remote assistance, you need to save various diagnostic data from the cluster and forward the data to the support staff. In this case, you can use Diag to collect diagnostic data with one click. Diag helps you to collect complete diagnostic data quickly, which can avoid complex manual data collection operations. After collecting data, you can upload the data to the Clinic Server for PingCAP technical support staff to troubleshoot cluster problems. The Clinic Server provides secure storage for uploaded diagnostic data and supports the online diagnosis, which greatly improves the troubleshooting efficiency.
When your cluster has some problems that cannot be fixed quickly, you can [get support](/support.md) from PingCAP or the community. When contacting technical support for remote assistance, you need to save various diagnostic data from the cluster and forward the data to the support staff. In this case, you can use Diag to collect diagnostic data with one click. Diag helps you to collect complete diagnostic data quickly, which can avoid complex manual data collection operations. After collecting data, you can upload the data to the Clinic Server for PingCAP technical support staff to troubleshoot cluster problems. The Clinic Server provides secure storage for uploaded diagnostic data and supports the online diagnosis, which greatly improves the troubleshooting efficiency.

- Quickly check cluster status

Expand Down Expand Up @@ -62,7 +62,7 @@ First, Diag gets cluster topology information from the deployment tool TiUP (tiu
> **Note:**
>
> - Clinic Server is free from July 15, 2022 to July 14, 2023. You will be notified through email before July 14, 2023 if the service starts charging fee afterwards.
> - If you want to adjust the usage limitations, contact PingCAP technical support.
> - If you want to adjust the usage limitations, [get support](/support.md) from PingCAP.
| Service Type| Limitation |
| :------ | :------ |
Expand Down
2 changes: 1 addition & 1 deletion clinic/clinic-user-guide-for-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For TiDB clusters and DM clusters deployed using TiUP, you can use PingCAP Clini

- [Troubleshoot cluster problems remotely](#troubleshoot-cluster-problems-remotely)

- When your cluster has some problems, if you need to contact PingCAP technical support, you can perform the following operations to facilitate the remote troubleshooting: collect diagnostic data with Diag, upload the collected data to the Clinic Server, and provide the data access link to the technical support staff.
- When your cluster has some problems, if you need to [get support](/support.md) from PingCAP, you can perform the following operations to facilitate the remote troubleshooting: collect diagnostic data with Diag, upload the collected data to the Clinic Server, and provide the data access link to the technical support staff.
- When your cluster has some problems, if you cannot analyze the problems immediately, you can use Diag to collect and save the data for later analysis.

- [Perform a quick check on the cluster status locally](#perform-a-quick-check-on-the-cluster-status-locally)
Expand Down
4 changes: 2 additions & 2 deletions dashboard/dashboard-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases: ['/docs/dev/dashboard/dashboard-faq/']

# TiDB Dashboard FAQs

This document summarizes the frequently asked questions (FAQs) and answers about TiDB Dashboard. If a problem cannot be located or persists after you perform as instructed, contact PingCAP technical support for help.
This document summarizes the frequently asked questions (FAQs) and answers about TiDB Dashboard. If a problem cannot be located or persists after you perform as instructed, [get support](/support.md) from PingCAP or the community.

## Access-related FAQ

Expand Down Expand Up @@ -120,7 +120,7 @@ Step 2. Add the ng_port configuration item on the control machine by using TiUP.
tiup cluster reload ${cluster-name} --role prometheus
```

Please Contact PingCAP Technical Support for help if the error message is still prompted after performing steps above.
If the error message is still prompted after performing steps above, [get support](/support.md) from PingCAP or the community.

</details>

Expand Down
2 changes: 1 addition & 1 deletion dm/dm-error-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ If you encounter an error while running DM, take the following steps to troubles

2. Check the log files related to the error. The log files are on the DM-master and DM-worker nodes. To get key information about the error, refer to the [error system](#error-system). Then check the [Handle Common Errors](#handle-common-errors) section to find the solution.

3. If the error is not covered in this document, and you cannot solve the problem by checking the log or monitoring metrics, you can contact the R&D.
3. If the error is not covered in this document, and you cannot solve the problem by checking the log or monitoring metrics, [get support](/support.md) from PingCAP or the community.

4. After the error is resolved, restart the task using dmctl.

Expand Down
18 changes: 9 additions & 9 deletions error-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the
>
> Some error codes stand for internal errors. Normally, TiDB handles the error rather than return it to the user, so some error codes are not listed here.
>
> If you encounter an error code that is not listed here, [contact PingCAP](mailto:info@pingcap.com) for support.
> If you encounter an error code that is not listed here, [get support](/support.md) from PingCAP or the community.

* Error Number: 8001

Expand All @@ -34,7 +34,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

If the data in a row is not consistent with the index when executing the [`ADMIN CHECK TABLE`](/sql-statements/sql-statement-admin-check-table-index.md) command, TiDB returns this error. This error is commonly seen when you check the data corruption in the table.

You can [contact PingCAP](mailto:info@pingcap.com) for support.
You can [get support](/support.md) from PingCAP or the community.

* Error Number: 8004

Expand Down Expand Up @@ -84,7 +84,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

Invalid transactions. If TiDB finds that no transaction ID (Start Timestamp) is obtained for the transaction that is being executed, which means this transaction is invalid, this error is returned.

Usually this error does not occur. If you encounter this error, [contact PingCAP](mailto:info@pingcap.com) for support.
Usually this error does not occur. If you encounter this error, [get support](/support.md) from PingCAP or the community.

* Error Number: 8025

Expand Down Expand Up @@ -166,13 +166,13 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

Unknown data type is encountered when TiDB parses the Exec argument list sent by the client.

If you encounter this error, check the client. If the client is normal, [contact PingCAP](mailto:info@pingcap.com) for support.
If you encounter this error, check the client. If the client is normal, [get support](/support.md) from PingCAP or the community.

* Error Number: 8052

The serial number of the data packet from the client is incorrect.

If you encounter this error, check the client. If the client is normal, [contact PingCAP](mailto:info@pingcap.com) for support.
If you encounter this error, check the client. If the client is normal, [get support](/support.md) from PingCAP or the community.

* Error Number: 8055

Expand Down Expand Up @@ -256,7 +256,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

The plugin defines a system variable whose name does not begin with the plugin name.

Contact the developer of the plugin to modify.
Contact the developer of the plugin to modify, or [get support](/support.md) from PingCAP or the community.

* Error Number: 8107

Expand All @@ -268,7 +268,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

Unsupported execution plan type. This error is an internal error.

If you encounter this error, [contact PingCAP](mailto:info@pingcap.com) for support.
If you encounter this error, [get support](/support.md) from PingCAP or the community.

* Error Number: 8109

Expand Down Expand Up @@ -372,7 +372,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

[`ADMIN REPAIR TABLE`](/sql-statements/sql-statement-admin.md#admin-repair-statement) fails.

If you encounter this error, [contact PingCAP](mailto:info@pingcap.com) for support.
If you encounter this error, [get support](/support.md) from PingCAP or the community.

* Error Number: 8216

Expand All @@ -384,7 +384,7 @@ TiDB is compatible with the error codes in MySQL, and in most cases returns the

This error occurs when detecting that the data is not consistent with the index.

If you encounter this error, [contact PingCAP](mailto:info@pingcap.com) for support.
If you encounter this error, [get support](/support.md) from PingCAP or the community.

* Error Number: 8224

Expand Down
4 changes: 2 additions & 2 deletions faq/migration-tidb-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ iperf Done.

If the output shows low network bandwidth and high bandwidth fluctuations, a large number of retries and EOF errors might appear in each component log. In this case, you need to consult your network service provider to improve the network quality.

If the output of each metric looks good, try to update each component. If the problem persists after the updating, you can [contact us](https://tidbcommunity.slack.com/archives/CH7TTLL7P).
If the output of each metric looks good, try to update each component. If the problem persists after the updating, [get support](/support.md) from PingCAP or the community.

### If I accidentally import the MySQL user table into TiDB, or forget the password and cannot log in, how to deal with it?

Expand Down Expand Up @@ -122,7 +122,7 @@ This issue might have the following causes:
+ The database's primary keys are not evenly distributed (for example, when you enable [`SHARD_ROW_ID_BITS`](/shard-row-id-bits.md)).
+ The upstream database is TiDB and the exported table is a partitioned table.

For the above cases, Dumpling splits excessively large data chunk for the export and sends queries with excessively large results. To address the issue, you can [contact us](https://tidbcommunity.slack.com/archives/CH7TTLL7P) to get the nightly version of Dumpling.
For the above cases, Dumpling splits excessively large data chunk for the export and sends queries with excessively large results. To address the issue, you can get the latest version of Dumpling.

### Does TiDB have a function like the Flashback Query in Oracle? Does it support DDL?

Expand Down
12 changes: 11 additions & 1 deletion non-transactional-dml.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,17 @@ In addition, when other concurrent writes occur, the number of rows processed in

The shard column does not support `ENUM`, `BIT`, `SET`, `JSON` types. Try to specify a new shard column. It is recommended to use an integer or string type column.

If the error occurs when the selected shard column is not one of these unsupported types, contact PingCAP technical support.
<CustomContent platform="tidb">

If the error occurs when the selected shard column is not one of these unsupported types, [get support](/support.md) from PingCAP or the community.

</CustomContent>

<CustomContent platform="tidb-cloud">

If the error occurs when the selected shard column is not one of these unsupported types, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).

</CustomContent>

### Non-transactional `DELETE` has "exceptional" behavior that is not equivalent to ordinary `DELETE`

Expand Down
2 changes: 1 addition & 1 deletion pessimistic-transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ set config tikv pessimistic-txn.pipelined='false';

<CustomContent platform="tidb-cloud">

If the application logic relies on the locking or lock waiting mechanisms, or if you want to guarantee as much as possible the success rate of transaction commits even in the case of TiKV cluster anomalies, you can contact <a href="mailto:tidbcloud-support@pingcap.com">PingCAP Support</a> to disable the pipelined locking feature.
If the application logic relies on the locking or lock waiting mechanisms, or if you want to guarantee as much as possible the success rate of transaction commits even in the case of TiKV cluster anomalies, you can [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) to disable the pipelined locking feature.

</CustomContent>

Expand Down
15 changes: 14 additions & 1 deletion sql-plan-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -533,10 +533,23 @@ SET GLOBAL tidb_evolve_plan_baselines = ON;

The default value of `tidb_evolve_plan_baselines` is `off`.

<CustomContent platform="tidb">

> **Warning:**
>
> + Baseline evolution is an experimental feature. Unknown risks might exist. It is **NOT** recommended that you use it in the production environment.
> + This variable is forcibly set to `off` until the baseline evolution feature becomes generally available (GA). If you try to enable this feature, an error is returned. If you have already used this feature in a production environment, disable it as soon as possible. If you find that the binding status is not as expected, [get support](/support.md) from PingCAP or the community.

</CustomContent>

<CustomContent platform="tidb-cloud">

> **Warning:**
>
> + Baseline evolution is an experimental feature. Unknown risks might exist. It is **NOT** recommended that you use it in the production environment.
> + This variable is forcibly set to `off` until the baseline evolution feature becomes generally available (GA). If you try to enable this feature, an error is returned. If you have already used this feature in a production environment, disable it as soon as possible. If you find that the binding status is not as expected, contact PingCAP's technical support for help.
> + This variable is forcibly set to `off` until the baseline evolution feature becomes generally available (GA). If you try to enable this feature, an error is returned. If you have already used this feature in a production environment, disable it as soon as possible. If you find that the binding status is not as expected, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).

</CustomContent>

After the automatic binding evolution feature is enabled, if the optimal execution plan selected by the optimizer is not among the binding execution plans, the optimizer marks the plan as an execution plan that waits for verification. At every `bind-info-lease` (the default value is `3s`) interval, an execution plan to be verified is selected and compared with the binding execution plan that has the least cost in terms of the actual execution time. If the plan to be verified has shorter execution time (the current criterion for the comparison is that the execution time of the plan to be verified is no longer than 2/3 that of the binding execution plan), this plan is marked as a usable binding. The following example describes the process above.

Expand Down
22 changes: 22 additions & 0 deletions support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
ran-huang marked this conversation as resolved.
Show resolved Hide resolved
title: Support Resources
summary: Find support resources if you encounter a problem using TiDB.
---

# Support Resources

If you encounter a problem when you use TiDB, you can reach out for support from PingCAP or the TiDB community via the following methods:

+ Get support from PingCAP (requires subscription to [TiDB Enterprise Edition](https://www.pingcap.com/tidb-enterprise/)):

- [Submit a request](https://support.pingcap.com/hc/en-us)

+ Seek help from the TiDB community:

- The [TiDB Forum](https://ask.pingcap.com/)
- Slack channels: [#everyone](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=docs) (English), [#tidb-japan](https://slack.tidb.io/invite?team=tidb-community&channel=tidb-japan&ref=docs) (Japanese)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/tidb) (questions tagged with #tidb)

+ Learn TiDB's implementation and design

- [TiDB Internals forum](https://internals.tidb.io/)
4 changes: 2 additions & 2 deletions tidb-binlog/monitor-tidb-binlog-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ For the critical-level alerts, a close watch on the abnormal metrics is required
- If Drainer `execute time` is too large, check the network bandwidth and latency between the machine with Drainer deployed and the machine with the target database deployed, and the state of the target database.
- If Drainer `execute time` is not too large and Drainer `event` is too small, add `work count` and `batch` and retry.

- If the two solutions above cannot work, contact [support@pingcap.com](mailto:support@pingcap.com).
- If the two solutions above cannot work, [get support](/support.md) from PingCAP or the community.

### Warning-level alerts

Expand All @@ -111,7 +111,7 @@ Warning-level alerts are a reminder for an issue or error.
* Solution:

- Verify the disk performance pressure and check the disk performance monitoring via `node exported`.
- If both `disk latency` and `util` are low, contact [support@pingcap.com](mailto:support@pingcap.com).
- If both `disk latency` and `util` are low, [get support](/support.md) from PingCAP or the community.

#### `binlog_pump_storage_write_binlog_duration_time_bucket`

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/limitations-and-quotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ TiDB Cloud limits how many of each kind of component you can create, and the com

> **Note:**
>
> If any of these limits or quotas present a problem for your organization, please contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md).
> If any of these limits or quotas present a problem for your organization, please contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).
## Cluster Limits

Expand Down