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

reference: add documentation for statement summary #1923

Closed
wants to merge 104 commits into from

Conversation

djshow832
Copy link
Contributor

What is changed, added or deleted?

Add documentation for statement summary.

Statement summary is recently released, and a documentation is needed to guide users.

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

master: pingcap/tidb#12017, pingcap/tidb#12217
release 3.0: pingcap/tidb#12306, pingcap/tidb#12308
release 3.1: pingcap/tidb#12328, pingcap/tidb#12499

Which version does your change affect?

dev, v3.0

july2993 and others added 30 commits September 11, 2019 15:04
Co-Authored-By: Ian <ArGregoryIan@gmail.com>
Co-Authored-By: WangXiangUSTC <wx347249478@gmail.com>
Co-Authored-By: WangXiangUSTC <wx347249478@gmail.com>
Co-Authored-By: WangXiangUSTC <wx347249478@gmail.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
Co-Authored-By: Lilian Lee <lilin@pingcap.com>
lonng and others added 2 commits October 11, 2019 19:23
…cap#1861)

* Add notes about "cluster-id mismatch"

* Update dev/tidb-in-kubernetes/troubleshoot.md

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update dev/tidb-in-kubernetes/troubleshoot.md

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

* Update dev/tidb-in-kubernetes/troubleshoot.md

Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>

* sync dev to v3.0

`events_statement_summary_by_digest` 是 `performance_schema` 里的一张系统表。顾名思义,它把 SQL 按 digest 分组,统计每一组的 SQL 信息。

digest 是什么呢?它与 slow log 里的 digest 一样,是把 SQL 规范化后算出的唯一标识符。
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest combine these several sentences into one paragraph. And also "digest 是什么呢?" sounds too casual and does not match our documentation style (the tone sounds suitable for a presentation or blog article)

Suggested change
digest 是什么呢?它与 slow log 里的 digest 一样,是把 SQL 规范化后算出的唯一标识符。
此处的 digest slow log 里的 digest 一样,是把 SQL 规范化后算出的唯一标识符。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed.


# Statement Summary Table

## 简介
Copy link
Contributor

Choose a reason for hiding this comment

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

On second thought, we don't need this title. Please remove it. Thanks.


# Statement Summary Table

## 简介
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## 简介

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed.


`events_statements_summary_by_digest` 现在还存在一些限制:

- 查询 `events_statements_summary_by_digest` 时,只会显示当前 TiDB-Server 的 statement summary,而不是整个群集的 statement summary。
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- 查询 `events_statements_summary_by_digest` 时,只会显示当前 TiDB-Server 的 statement summary,而不是整个群集的 statement summary。
- 查询 `events_statements_summary_by_digest` 时,只会显示当前 TiDB-Server 的 statement summary,而不是整个集群的 statement summary。

@dcalvin dcalvin 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 Oct 12, 2019
@djshow832 djshow832 closed this Oct 12, 2019
@lilin90
Copy link
Member

lilin90 commented Oct 14, 2019

@djshow832 Please add a reason why you closed this PR and add the related PR if possible. @dcalvin FYI.

@lilin90
Copy link
Member

lilin90 commented Oct 14, 2019

This PR is closed. Updates are made in a new PR #1939.

@lilin90 lilin90 removed the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Oct 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet