add troubleshoot doc for TiCDC #2615
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
lilin90
reviewed
May 26, 2020
ticdc/troubleshoot-ticdc.md
Outdated
|
|
||
| # Common Problems and Troubleshooting | ||
|
|
||
| This document includes some common problems while using TiCDC and appropriate solutions. It also summarizes some common operation failures and ways to fix them. |
Member
There was a problem hiding this comment.
Adverbial clauses can omit the subject (and the be verb) only if the subject of the dependent (the adverbial clause) is the same as that of the independent clause. Multiple similar issues exist in this PR.
Author
There was a problem hiding this comment.
Thanks for your review. I have added possible subjects (not 100% sure). The subject seemed vague to me in some original sentences, because I didn't get the whole picture of TiCDC.
ticdc/troubleshoot-ticdc.md
Outdated
|
|
||
| ## How to choose start-ts while starting a task | ||
|
|
||
| First, you should know that the `start-ts` of a replication task corresponds to a TSO of the upstream TiDB cluster. The replication task will start its data request from this TSO. Therefore, the `start-ts` should meet two conditions below: |
Member
There was a problem hiding this comment.
Limit the use of should in user documentation.
Author
There was a problem hiding this comment.
I found that should (111 times), need(s) to (125 times) and must (118 times) are almost equally used in current TiDB docs and their links, but should seldom goes with user or you . So, I changed some of should to need to or must.
ticdc/troubleshoot-ticdc.md
Outdated
|
|
||
| ## When a task gets started, it prompts that some tables cannot be replicated | ||
|
|
||
| When using `cdc cli changefeed create` to create a replication task, it will check if the upstream tables comply with the [restrictions](/ticdc/ticdc-overview.md#restrictions). If not, it will prompt that `some tables are not eligible to replicate` and list out the ineligible tables. If you choose `Y` or `y`, you will continue creating the replication task and automatically ignore all the updates of these ineligible tables. If you choose other inputs, the replication task will not be created. |
yikeke
added
status/require-change
Contributor
|
@Anastasia-Lu, please update your pull request. |
1 similar comment
Contributor
|
@Anastasia-Lu, please update your pull request. |
Contributor
|
@Anastasia-Lu, please update your pull request. |
1 similar comment
Contributor
|
@Anastasia-Lu, please update your pull request. |
yikeke
added
status/PTAL
TomShawn
reviewed
Jun 9, 2020
|
|
||
| # Common Problems and Troubleshooting | ||
|
|
||
| This document includes some common problems that you might have while using TiCDC and provides appropriate solutions. It also summarizes some common operation failures and ways to fix them. |
Contributor
There was a problem hiding this comment.
Suggested change
| This document includes some common problems that you might have while using TiCDC and provides appropriate solutions. It also summarizes some common operation failures and ways to fix them. | |
| This document includes some common problems that you might have while using TiCDC and provides appropriate solutions. It also summarizes some common operation problems and ways to fix them. |
|
|
||
| First, you need to know that the `start-ts` of a replication task corresponds to a TSO of the upstream TiDB cluster. The replication task will start its data request from this TSO. Therefore, the `start-ts` should meet two conditions below: | ||
|
|
||
| - The value of `start-ts` must be larger than current `tikv_gc_safe_point`, otherwise, an error would occur when creating the task. |
Contributor
There was a problem hiding this comment.
Suggested change
| - The value of `start-ts` must be larger than current `tikv_gc_safe_point`, otherwise, an error would occur when creating the task. | |
| - The value of `start-ts` must be larger than current `tikv_gc_safe_point` value. Otherwise, an error will occurs when you create a task. |
| - The value of `start-ts` must be larger than current `tikv_gc_safe_point`, otherwise, an error would occur when creating the task. | ||
| - While starting a task, you need to ensure that the downstream has already got all the data previous to `start-ts`. You can relax this requirement accordingly, if the replication task is for message queue or other scenarios, in which strict data consistency between upstream and downstream is not strictly required. | ||
|
|
||
| If `start-ts` is not specified or specified as `0`, when a replication task gets started, TiCDC will get the current TSO from PD and start to replicate data from it. |
Contributor
There was a problem hiding this comment.
Suggested change
| If `start-ts` is not specified or specified as `0`, when a replication task gets started, TiCDC will get the current TSO from PD and start to replicate data from it. | |
| If `start-ts` is not specified or specified as `0`, when a replication task is started, TiCDC will get the current TSO from PD and start to replicate data from this TSO. |
|
|
||
| ## When a task gets started, it prompts that some tables cannot be replicated | ||
|
|
||
| When you use `cdc cli changefeed create` to create a replication task, TiCDC will check if the upstream tables comply with the [restrictions](/ticdc/ticdc-overview.md#restrictions). If they don't, TiCDC will prompt that `some tables are not eligible to replicate`, and will list out the ineligible tables. If you choose `Y` or `y`, TiCDC will continue creating the replication task and automatically ignore all the updates of these ineligible tables. If you choose other inputs, the replication task will not be created. |
Contributor
There was a problem hiding this comment.
Suggested change
| When you use `cdc cli changefeed create` to create a replication task, TiCDC will check if the upstream tables comply with the [restrictions](/ticdc/ticdc-overview.md#restrictions). If they don't, TiCDC will prompt that `some tables are not eligible to replicate`, and will list out the ineligible tables. If you choose `Y` or `y`, TiCDC will continue creating the replication task and automatically ignore all the updates of these ineligible tables. If you choose other inputs, the replication task will not be created. | |
| When you execute `cdc cli changefeed create` to create a replication task, TiCDC will check whether the upstream tables meet the [restrictions](/ticdc/ticdc-overview.md#restrictions). If not, TiCDC will prompt that `some tables are not eligible to replicate`, and will list out the ineligible tables. If you choose `Y` or `y`, TiCDC will continue creating the replication task and automatically ignore all the updates of these ineligible tables. If you choose other inputs, the replication task will not be created. |
Contributor
|
The change of this PR is made in #2751. So I'll close this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted? (Required)
Translate the troubleshoot doc for TiCDC till the end of the second subtitle.
Which TiDB version(s) do your changes apply to? (Required)
If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-4.0, needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.
What is the related PR or file link(s)?