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.

Sign up for GitHub

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

Jump to bottom

Add Telemetry Docs #3812

Merged
merged 22 commits into from
Jun 30, 2020
Merged

Add Telemetry Docs #3812

merged 22 commits into from
Jun 30, 2020

Conversation

breezewish
Copy link
Member

@breezewish breezewish commented Jun 29, 2020 •
edited
Loading

What is changed, added or deleted? (Required)

Add docs about the telemetry functionality introduced in TiDB v4.0.2.

The following images demostrate how it looks like for the <details> tag when rendering on PingCAP docs:

image

image

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

@github-actions github-actions bot requested a review from TomShawn June 29, 2020 05:37
@github-actions github-actions bot added translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. status/PTAL This PR is ready for reviewing. labels Jun 29, 2020
This was referenced Jun 29, 2020
Merged
Merged
Merged
july2993
july2993 reviewed Jun 29, 2020
View reviewed changes
telemetry.md
SET GLOBAL tidb_enable_telemetry = 0;
```

配置文件的禁用优先级高于全局变量。若通过配置文件禁用了遥测功能，则全局变量的配置将不起作用，遥测功能总是处于关闭状态。
Copy link
Contributor

@july2993 july2993 Jun 29, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

如果配置文件开启（虽然不会这么配），也是没法用系统变量关掉的对吧

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

配置文件中开启是默认的行为，这个情况下可以用系统变量关闭

july2993
july2993 reviewed Jun 29, 2020
View reviewed changes
Copy link
Contributor

@july2993 july2993 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@breezewish breezewish changed the title WIP: Add Telemetry Docs Add Telemetry Docs Jun 29, 2020
@TomShawn TomShawn added needs-cherry-pick-4.0 size/large Changes of a large size. translation/doing This PR’s assignee is translating this PR. and removed translation/welcome Waits for a contributor to translate this PR and create a PR to the pingcap/docs-cn repository. status/PTAL This PR is ready for reviewing. labels Jun 29, 2020
breezewish and others added 4 commits June 29, 2020 16:37
@breezewish
Merge branch 'master' into telemetry
b6e20d4
@breezewish
理解和改善产品 -> 理解产品
1cbda7c 
Signed-off-by: Breezewish <me@breeswish.org>
@breezewish
Polish some words
c42d42a 
Signed-off-by: Breezewish <me@breeswish.org>
@breezewish
Reformat
5f9c6bc 
Signed-off-by: Breezewish <me@breeswish.org>
@breezewish breezewish mentioned this pull request Jun 29, 2020
Merged
5 tasks
@breezewish
Address some comments
c8458b4 
Signed-off-by: Breezewish <me@breeswish.org>
TomShawn
TomShawn reviewed Jun 29, 2020
View reviewed changes
telemetry.md Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Show resolved Hide resolved
upgrade-tidb-using-tiup.md Outdated Show resolved Hide resolved
upgrade-tidb-using-tiup-offline.md Outdated Show resolved Hide resolved
quick-start-with-tidb.md Outdated Show resolved Hide resolved
production-offline-deployment-using-tiup.md Outdated Show resolved Hide resolved
pd-configuration-file.md Outdated Show resolved Hide resolved
@TomShawn TomShawn requested a review from winkyao June 29, 2020 12:40
winkyao
winkyao reviewed Jun 29, 2020
View reviewed changes
Copy link
Contributor

@winkyao winkyao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

TomShawn
TomShawn reviewed Jun 29, 2020
View reviewed changes
pd-configuration-file.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
telemetry.md Outdated Show resolved Hide resolved
@TomShawn TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Jun 29, 2020
TomShawn
TomShawn approved these changes Jun 30, 2020
View reviewed changes
Copy link
Contributor

@TomShawn TomShawn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TomShawn TomShawn added the status/can-merge Indicates a PR has been approved by a committer. label Jun 30, 2020
@ti-srebot
Copy link
Contributor

/run-all-tests

@ti-srebot ti-srebot merged commit 2153a91 into master Jun 30, 2020
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Jun 30, 2020
@breezewish @ti-srebot
cherry pick pingcap#3812 to release-4.0
cc1fe21 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Jun 30, 2020
Merged
6 tasks
@ti-srebot
Copy link
Contributor

cherry pick to release-4.0 in PR #3821

ti-srebot added a commit that referenced this pull request Jun 30, 2020
@ti-srebot @breezewish
Add Telemetry Docs (#3812) (#3821)
ef12eaa 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: Wenxuan <hi@breeswish.org>
@breezewish breezewish deleted the telemetry branch June 30, 2020 03:03
This was referenced Jun 30, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@winkyao winkyao winkyao left review comments

@july2993 july2993 july2993 left review comments

@TomShawn TomShawn TomShawn approved these changes

Assignees

@breezewish breezewish

Labels
size/large Changes of a large size. status/can-merge Indicates a PR has been approved by a committer. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@breezewish @ti-srebot @july2993 @winkyao @TomShawn @DanielZhangQD