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

issue_template: add template for performance issue #9021

Merged
merged 17 commits into from
Feb 12, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: "\U0001F914 Question"
name: "\U0001F914 General Question"
about: Usage question that isn't answered in docs or discussion

---

## Question
## General Question

Before asking a question, make sure you have:

Expand All @@ -13,4 +13,4 @@ Before asking a question, make sure you have:
- Searched open and closed [GitHub issues](https://github.com/pingcap/tidb/issues?utf8=%E2%9C%93&q=is%3Aissue)
- Read the documentation:
- [TiDB Readme](https://github.com/pingcap/tidb)
- [TiDB Doc](https://github.com/pingcap/docs)
- [TiDB Doc](https://github.com/pingcap/docs)
Copy link
Member Author

Choose a reason for hiding this comment

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

It's strange that this line is marked as changed

Copy link
Member

Choose a reason for hiding this comment

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

EOF issue?

Copy link
Member Author

Choose a reason for hiding this comment

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

a new line added. But seems no influence

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/performance-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "\U0001F947 Performance Question"
about: Performance question about TiDB which is not caused by bug.
winoros marked this conversation as resolved.
Show resolved Hide resolved

winoros marked this conversation as resolved.
Show resolved Hide resolved
---

## Performance Question
winoros marked this conversation as resolved.
Show resolved Hide resolved

- What version of TiDB are you using (`tidb-server -V` or run `select tidb_version();` on TiDB)?
winoros marked this conversation as resolved.
Show resolved Hide resolved

- What's the difference between the performance you expect and the performance you observe?
winoros marked this conversation as resolved.
Show resolved Hide resolved

- Are you comparing TiDB with some other database? What's the difference between TiDB and compared one?
winoros marked this conversation as resolved.
Show resolved Hide resolved

- If it's a specific SQL query, could you please
winoros marked this conversation as resolved.
Show resolved Hide resolved
winoros marked this conversation as resolved.
Show resolved Hide resolved
- let us know whether you get your result after analyzing the table involved in the query.
winoros marked this conversation as resolved.
Show resolved Hide resolved
- tell us whether this SQL always runs slowly, or just occasionally.
winoros marked this conversation as resolved.
Show resolved Hide resolved
- provide the `EXPLAIN ANALYZE` result of this query if you can wait until this SQL's execution finishes and your TiDB version is no lower than 2.1, or you can just provide the `EXPLAIN` result.
winoros marked this conversation as resolved.
Show resolved Hide resolved
- provide the plain text of the SQL and table schema so we can test it locally. It'll be more better if you can provide the dumped statistics information.
winoros marked this conversation as resolved.
Show resolved Hide resolved
- use `show create table ${involved_table}\G` to get the table schema.
- use `curl -G "http://${tidb-server-ip}:${tidb-server-status-port}/stats/dump/${db_name}/${table_name}" > ${table_name}_stats.json` to get the dumped statistics of one involved table.
- provide the `EXPLAIN` result of the compared database. For mysql, `EXPLAIN format=json`'s result will be more helpful.
winoros marked this conversation as resolved.
Show resolved Hide resolved
- other information that you think it's useful to distinguish the property of this SQL.
winoros marked this conversation as resolved.
Show resolved Hide resolved