bootstrap: add summary field for system table `tidb_background_subtask` #46562

tangenta · 2023-08-31T10:24:55Z

What problem does this PR solve?

Issue Number: ref #46258

Problem Summary:

We need a field to record the subtask execution statistic(for example, affected row count). Basically, there are three options:

Add a field row_count INTEGER to tidb_background_subtask.
Serialize the row_count in meta BLOB of tidb_background_subtask.
Add a field summary JSON to tidb_background_subtask.

For option 1, it is not extensive to collect more execution statistic. For option 2, it is not convenient to collect the information without deserializing the whole meta blob value.

Option 3 is a better choice since we make json functions GA in TiDB v6.5.0.

Example usage:

mysql> show create table tidb_background_subtask;
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Table                   | Create Table                                                                                                                                                           |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tidb_background_subtask | CREATE TABLE `tidb_background_subtask` (
  `id` int(11) DEFAULT NULL,
  `summary` json DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Create subtask:

insert into tidb_background_subtask values (1, '{}');

Update row count:

update tidb_background_subtask set summary= json_set(summary, "$.row_count", "255") where id = 1;

Collect total row count:

mysql> table tidb_background_subtask;
+------+----------------------+
| id   | summary              |
+------+----------------------+
|    1 | {"row_count": "255"} |
|    2 | {"row_count": "2"}   |
|    3 | {"row_count": "3"}   |
+------+----------------------+

mysql> select json_extract(summary, '$.row_count') from tidb_background_subtask;
+---------------------------------------------+
| json_extract(summary, '$.row_count')        |
+---------------------------------------------+
| "255"                                       |
| "2"                                         |
| "3"                                         |
+---------------------------------------------+

mysql> select sum(json_extract(summary, '$.row_count')) from tidb_background_subtask;
+--------------------------------------------------+
| sum(json_extract(summary, '$.row_count'))        |
+--------------------------------------------------+
|                                              260 |
+--------------------------------------------------+
1 row in set (0.01 sec)

What is changed and how it works?

Add a field summary JSON to tidb_background_subtask.

Check List

Tests

Unit test
Integration test
Manual test (add detailed scripts or steps below)
No code

Side effects

Performance regression: Consumes more CPU
Performance regression: Consumes more Memory
Breaking backward compatibility

Documentation

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

tiprow · 2023-08-31T10:25:29Z

Hi @tangenta. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

D3Hunter · 2023-08-31T10:35:33Z

ddl/constant.go

@@ -65,9 +61,10 @@ const (
 		state_update_time bigint,
 		meta longblob,
 		error BLOB,
+		execution_info json,


prefer name it as summary

codecov · 2023-08-31T11:09:21Z

Codecov Report

Merging #46562 (d3db0fb) into master (7e66761) will decrease coverage by 1.0377%.
Report is 20 commits behind head on master.
The diff coverage is 71.4285%.

Additional details and impacted files

@@               Coverage Diff                @@
##             master     #46562        +/-   ##
================================================
- Coverage   73.3392%   72.3015%   -1.0377%     
================================================
  Files          1309       1332        +23     
  Lines        394535     404958     +10423     
================================================
+ Hits         289349     292791      +3442     
- Misses        86772      93620      +6848     
- Partials      18414      18547       +133

Flag	Coverage Δ
integration	`25.7499% <0.0000%> (?)`
unit	`73.3351% <76.9230%> (-0.0041%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
dumpling	`54.0444% <ø> (ø)`
parser	`84.9520% <ø> (-0.0253%)`	⬇️
br	`47.0848% <ø> (-5.2659%)`	⬇️

bb7133

LGTM

disttask/framework/storage/task_table.go

session/bootstraptest/bootstrap_upgrade_test.go

zimulala · 2023-09-01T05:29:27Z

ddl/constant.go

@@ -80,5 +77,6 @@ const (
 		start_time bigint,
 		state_update_time bigint,
 		meta longblob,
+		summary json,


Why replace ExecutionInfo with summary?

It is the short term of "subtask execution summary". I think both are fine.

ti-chi-bot · 2023-09-01T08:00:12Z

[LGTM Timeline notifier]

Timeline:

2023-09-01 02:17:15.047028772 +0000 UTC m=+2066199.596044759: ☑️ agreed by bb7133.
2023-09-01 08:00:10.887731003 +0000 UTC m=+2086775.436746990: ☑️ agreed by wjhuang2016.

lance6716 · 2023-09-01T08:47:18Z

/approve

easonn7 · 2023-09-01T08:59:52Z

/approve

ti-chi-bot · 2023-09-01T08:59:58Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bb7133, easonn7, lance6716, wjhuang2016, ywqzzy

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [bb7133,lance6716,wjhuang2016]
~~session/OWNERS~~ [easonn7]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tangenta · 2023-09-01T09:16:47Z

/retest

tiprow · 2023-09-01T09:17:18Z

@tangenta: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

tangenta · 2023-09-01T09:17:41Z

/ok-to-test

tangenta · 2023-09-01T10:15:23Z

/retest

hawkingrei · 2023-09-01T16:43:40Z

/retest

hawkingrei · 2023-09-03T14:08:08Z

/retest

hawkingrei · 2023-09-04T01:09:59Z

/test all

bootstrap: add exec info field for system table tidb_background_subtask

0ecab1e

tangenta requested a review from a team as a code owner August 31, 2023 10:24

ti-chi-bot bot added release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 31, 2023

D3Hunter reviewed Aug 31, 2023

View reviewed changes

tangenta changed the title ~~bootstrap: add exec info field for system table tidb_background_subtask~~ [WIP] bootstrap: add exec info field for system table tidb_background_subtask Aug 31, 2023

ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 31, 2023

add tests

f81b231

tangenta added 2 commits August 31, 2023 22:35

fix unit test and rename to summary

aa383c5

refine ut name

206738c

tangenta changed the title ~~[WIP] bootstrap: add exec info field for system table tidb_background_subtask~~ bootstrap: add exec info field for system table tidb_background_subtask Aug 31, 2023

ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 31, 2023

tangenta changed the title ~~bootstrap: add exec info field for system table tidb_background_subtask~~ bootstrap: add summary field for system table tidb_background_subtask Aug 31, 2023

update bazel

566dddb

bb7133 approved these changes Sep 1, 2023

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 1, 2023

zimulala reviewed Sep 1, 2023

View reviewed changes

disttask/framework/storage/task_table.go Outdated Show resolved Hide resolved

tangenta added 3 commits September 1, 2023 10:48

update subtask field name

2d2fb25

fix invalid json text

fdd223e

fix TestUpgradeVersionForUpgradeHTTPOp

b11d4c6

tangenta mentioned this pull request Sep 1, 2023

ddl: integrate add index operator to dist framework #46495

Merged

12 tasks

zimulala reviewed Sep 1, 2023

View reviewed changes

session/bootstraptest/bootstrap_upgrade_test.go Outdated Show resolved Hide resolved

address comment

d3db0fb

zimulala reviewed Sep 1, 2023

View reviewed changes

wjhuang2016 approved these changes Sep 1, 2023

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Sep 1, 2023

ywqzzy approved these changes Sep 1, 2023

View reviewed changes

ti-chi-bot bot added the approved label Sep 1, 2023

ti-chi-bot bot added the ok-to-test Indicates a PR is ready to be tested. label Sep 1, 2023

ti-chi-bot bot merged commit a427113 into pingcap:master Sep 4, 2023
3 of 9 checks passed

ywqzzy mentioned this pull request Sep 4, 2023

Enhance distributed task execution framework #46258

Closed

76 tasks

CabinfeverB mentioned this pull request Sep 4, 2023

bootstrap: change SupportUpgradeHTTPOpVer to fix upgrade error #46622

Merged

12 tasks

D3Hunter mentioned this pull request Jun 26, 2024

v7.5.2(upgrade from 7.1.5) show import jobs report unknow column summary #54241

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bootstrap: add summary field for system table `tidb_background_subtask` #46562

bootstrap: add summary field for system table `tidb_background_subtask` #46562

tangenta commented Aug 31, 2023 •

edited

Loading

tiprow bot commented Aug 31, 2023

D3Hunter Aug 31, 2023

tangenta Aug 31, 2023

codecov bot commented Aug 31, 2023 •

edited

Loading

bb7133 left a comment

zimulala Sep 1, 2023

tangenta Sep 1, 2023

ti-chi-bot bot commented Sep 1, 2023

lance6716 commented Sep 1, 2023

easonn7 commented Sep 1, 2023

ti-chi-bot bot commented Sep 1, 2023

tangenta commented Sep 1, 2023

tiprow bot commented Sep 1, 2023

tangenta commented Sep 1, 2023

tangenta commented Sep 1, 2023

hawkingrei commented Sep 1, 2023

hawkingrei commented Sep 3, 2023

hawkingrei commented Sep 4, 2023

bootstrap: add summary field for system table tidb_background_subtask #46562

bootstrap: add summary field for system table tidb_background_subtask #46562

Conversation

tangenta commented Aug 31, 2023 • edited Loading

What problem does this PR solve?

What is changed and how it works?

Check List

Release note

tiprow bot commented Aug 31, 2023

D3Hunter Aug 31, 2023

Choose a reason for hiding this comment

tangenta Aug 31, 2023

Choose a reason for hiding this comment

codecov bot commented Aug 31, 2023 • edited Loading

Codecov Report

bb7133 left a comment

Choose a reason for hiding this comment

zimulala Sep 1, 2023

Choose a reason for hiding this comment

tangenta Sep 1, 2023

Choose a reason for hiding this comment

ti-chi-bot bot commented Sep 1, 2023

[LGTM Timeline notifier]

lance6716 commented Sep 1, 2023

easonn7 commented Sep 1, 2023

ti-chi-bot bot commented Sep 1, 2023

tangenta commented Sep 1, 2023

tiprow bot commented Sep 1, 2023

tangenta commented Sep 1, 2023

tangenta commented Sep 1, 2023

hawkingrei commented Sep 1, 2023

hawkingrei commented Sep 3, 2023

hawkingrei commented Sep 4, 2023

bootstrap: add summary field for system table `tidb_background_subtask` #46562

bootstrap: add summary field for system table `tidb_background_subtask` #46562

tangenta commented Aug 31, 2023 •

edited

Loading

codecov bot commented Aug 31, 2023 •

edited

Loading