metrics: attach const label keyspace_id #41693

lionelee · 2023-02-23T07:25:06Z

What problem does this PR solve?

Issue Number: close #41698

Problem Summary:

What is changed and how it works?

If keyspace-name is set in the configuration, the TiDB node will get the corresponding keyspace id from PD, and then register metrics with const label 'keyspace_id' attached.

Check List

Tests

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

Manual test

without keyspace-name set in tidb config:

create a TiDB cluster with 3 tidb-server , 3 tikv-server and 3 pd-server.
connect to a tidb instance, and do some queries
view the metrics

with keyspace-name set in tidb config:

create a TiDB cluster with 3 tidb-server , 3 tikv-server and 3 pd-server(with pre-alloc keyspace in config).
connect to a tidb instance, and do some queries
view the metrics

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.

metrics: attach const label keyspace_id

ti-chi-bot · 2023-02-23T07:25:08Z

[REVIEW NOTIFICATION]

This pull request has been approved by:

CbcWestwolf
hawkingrei

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

ti-chi-bot · 2023-02-23T07:25:08Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

sre-bot · 2023-02-23T07:25:13Z

All committers have signed the CLA.

hawkingrei · 2023-02-23T07:50:41Z

server/metrics.go

+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package server


Some package, like server, executor, and so on, is too large to build in a short time. I suggest you can create a new package like executor/metrics to put this file.

ystaticy · 2023-03-01T06:13:32Z

The results of the manual test should be provided in this PR description.

lionelee · 2023-03-01T06:26:51Z

The results of the manual test should be provided in this PR description.

done

ystaticy · 2023-03-01T07:10:06Z

The screenshot needs to be verified.When keyspace-name is configured, metrics will have the label of keyspace_id, if the keyspace-name is not configured, metrics will not have the label of keyspace_id,

CbcWestwolf · 2023-03-01T08:09:50Z

util/topsql/reporter/metrics.go

-	ignoreExceedSQLCounter              = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_exceed_sql")
-	ignoreExceedPlanCounter             = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_exceed_plan")
-	ignoreCollectChannelFullCounter     = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_collect_channel_full")
+	ignoreExceedSQLCounter              prometheus.Counter


It looks like most of the changes are such separation of declaration and initialization.
Do we have a strong motivation to deliver this change of code style?

We will re-initialize metrics after getting keyspace from config, and these corresponding metrics variables should also be re-initialized. Thus, we conduct the separation of declaration and initialization.

Can we just initialize metircs once?

I'm not sure, it's worth a try. But no matter whether the metrics are initialized once or twice, the separation of declaration and initialization is needed.

zeminzhou · 2023-03-01T10:18:32Z

/test unit-test

CbcWestwolf · 2023-03-01T11:40:09Z

/retest-required

zeminzhou · 2023-03-02T02:35:42Z

metrics/wrapper.go

+
+import "github.com/prometheus/client_golang/prometheus"
+
+var keyspaceLabels prometheus.Labels


We can use a more generic name so that we may add more labels in the future.

zeminzhou · 2023-03-02T02:39:18Z

util/topsql/reporter/metrics.go

-	ignoreExceedSQLCounter              = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_exceed_sql")
-	ignoreExceedPlanCounter             = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_exceed_plan")
-	ignoreCollectChannelFullCounter     = metrics.TopSQLIgnoredCounter.WithLabelValues("ignore_collect_channel_full")
+	ignoreExceedSQLCounter              prometheus.Counter


Can we just initialize metircs once?

ystaticy

LGTM

ti-chi-bot · 2023-03-03T09:11:50Z

@ystaticy: Thanks for your review. The bot only counts approvals from reviewers and higher roles in list, but you're still welcome to leave your comments.

In response to this:

LGTM

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 ti-community-infra/tichi repository.

hawkingrei · 2023-03-03T15:22:16Z

/merge

ti-chi-bot · 2023-03-03T15:22:19Z

This pull request has been accepted and is ready to merge.

Commit hash: a7b8b73

metrics: attach const label keyspace_id

1dc35a5

ti-chi-bot added do-not-merge/needs-linked-issue release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. labels Feb 23, 2023

ti-chi-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Feb 23, 2023

hawkingrei reviewed Feb 23, 2023

View reviewed changes

ti-chi-bot removed the do-not-merge/needs-linked-issue label Feb 23, 2023

fix lint

7cae181

ti-chi-bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Mar 1, 2023

Merge branch 'master' into add_metrics_label_keyspace

0dc45fa

ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 1, 2023

lionelee marked this pull request as ready for review March 1, 2023 06:26

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

fix merge

f452095

CbcWestwolf reviewed Mar 1, 2023

View reviewed changes

zeminzhou reviewed Mar 2, 2023

View reviewed changes

create new packages to put metrics vars

a5c3930

lionelee force-pushed the add_metrics_label_keyspace branch from 4bf9c55 to a5c3930 Compare March 2, 2023 05:48

make const labels more generic

a7b8b73

CbcWestwolf approved these changes Mar 3, 2023

View reviewed changes

ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 3, 2023

hawkingrei approved these changes Mar 3, 2023

View reviewed changes

ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 3, 2023

ystaticy approved these changes Mar 3, 2023

View reviewed changes

ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 3, 2023

ti-chi-bot merged commit 7235267 into pingcap:master Mar 3, 2023

ystaticy mentioned this pull request Dec 8, 2023

Introduce Keyspace #40425

Open

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

metrics: attach const label keyspace_id #41693

metrics: attach const label keyspace_id #41693

lionelee commented Feb 23, 2023 •

edited

Loading

ti-chi-bot commented Feb 23, 2023 •

edited

Loading

ti-chi-bot commented Feb 23, 2023

sre-bot commented Feb 23, 2023 •

edited

Loading

hawkingrei Feb 23, 2023

lionelee Mar 2, 2023

ystaticy commented Mar 1, 2023

lionelee commented Mar 1, 2023

ystaticy commented Mar 1, 2023

CbcWestwolf Mar 1, 2023

lionelee Mar 1, 2023

zeminzhou Mar 2, 2023

lionelee Mar 2, 2023

zeminzhou commented Mar 1, 2023

CbcWestwolf commented Mar 1, 2023

zeminzhou Mar 2, 2023

lionelee Mar 2, 2023

zeminzhou Mar 2, 2023

ystaticy left a comment

ti-chi-bot commented Mar 3, 2023

hawkingrei commented Mar 3, 2023

ti-chi-bot commented Mar 3, 2023


		import "github.com/prometheus/client_golang/prometheus"

		var keyspaceLabels prometheus.Labels

metrics: attach const label keyspace_id #41693

metrics: attach const label keyspace_id #41693

Conversation

lionelee commented Feb 23, 2023 • edited Loading

What problem does this PR solve?

What is changed and how it works?

Check List

Release note

ti-chi-bot commented Feb 23, 2023 • edited Loading

ti-chi-bot commented Feb 23, 2023

sre-bot commented Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ystaticy commented Mar 1, 2023

lionelee commented Mar 1, 2023

ystaticy commented Mar 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zeminzhou commented Mar 1, 2023

CbcWestwolf commented Mar 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ystaticy left a comment

Choose a reason for hiding this comment

ti-chi-bot commented Mar 3, 2023

hawkingrei commented Mar 3, 2023

ti-chi-bot commented Mar 3, 2023

lionelee commented Feb 23, 2023 •

edited

Loading

ti-chi-bot commented Feb 23, 2023 •

edited

Loading

sre-bot commented Feb 23, 2023 •

edited

Loading