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

client/http: introduce caller ID into the HTTP client #7490

Merged
merged 3 commits into from
Dec 4, 2023
Merged

client/http: introduce caller ID into the HTTP client #7490

merged 3 commits into from
Dec 4, 2023

Conversation

JmPotato
Copy link
Member

@JmPotato JmPotato commented Dec 4, 2023

What problem does this PR solve?

Issue Number: ref #7300.

What is changed and how does it work?

Introduce caller ID into the HTTP client.

Check List

Tests

  • Unit test
  • Integration test

Release note

None.

@JmPotato JmPotato added the component/client Client logic. label Dec 4, 2023
@ti-chi-bot ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Dec 4, 2023 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • CabinfeverB
  • HuSharp

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 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 Dec 4, 2023
@codecov Codecov
Copy link

codecov bot commented Dec 4, 2023 •
edited
Loading

Codecov Report

Merging #7490 (0091655) into master (259435d) will increase coverage by 0.02%.
The diff coverage is 52.17%.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #7490      +/-   ##
==========================================
+ Coverage   74.31%   74.33%   +0.02%     
==========================================
  Files         452      452              
  Lines       49918    49926       +8     
==========================================
+ Hits        37097    37114      +17     
+ Misses       9488     9479       -9     
  Partials     3333     3333
Flag Coverage Δ
unittests 74.33% <52.17%> (+0.02%) ⬆️

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

@JmPotato
Introduce caller ID into the HTTP client
5b0fe23 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@JmPotato
Set the component header key with the caller ID
3d4a605 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 4, 2023
@JmPotato JmPotato requested a review from nolouch December 4, 2023 06:53
@JmPotato
Add the client request check tests
0091655 
Signed-off-by: JmPotato <ghzpotato@gmail.com>
@ti-chi-bot ti-chi-bot bot added the status/LGT1 Indicates that a PR has LGTM 1. label Dec 4, 2023
@ti-chi-bot ti-chi-bot bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Dec 4, 2023
@JmPotato
Copy link
Member Author

JmPotato commented Dec 4, 2023

/merge

@ti-chi-bot ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Dec 4, 2023

@JmPotato: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

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.

@ti-chi-bot ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Dec 4, 2023

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

Commit hash: 0091655

@ti-chi-bot ti-chi-bot bot added the status/can-merge Indicates a PR has been approved by a committer. label Dec 4, 2023
@ti-chi-bot ti-chi-bot bot merged commit 080af97 into tikv:master Dec 4, 2023
24 of 26 checks passed
@JmPotato JmPotato deleted the add_caller_id branch December 4, 2023 08:01
niubell
niubell reviewed Dec 12, 2023
View reviewed changes
client/http/client.go
// Header key definition constants.
const (
pdAllowFollowerHandleKey = "PD-Allow-Follower-Handle"
componentSignatureKey = "component"
Copy link
Contributor

Choose a reason for hiding this comment

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

We can have a more intuitive name like 'CallerID', and it's a filed in http header, "X-Caller-ID" maybe a better name according HTTP RFC docs @JmPotato

Copy link
Member Author

Choose a reason for hiding this comment

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

Using component here is to reuse https://github.com/tikv/pd/blob/master/pkg/utils/requestutil/request_info.go#L52, but you're right about the naming, we could create a new filed to distinguish with it.

client/http/client.go
@@ -239,6 +267,8 @@ func (c *client) request(
logFields := []zap.Field{
zap.String("name", name),
zap.String("url", url),
zap.String("method", method),
zap.String("caller-id", c.callerID),
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we log the caller id on the PD server side?

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 will appear in the audit log also.

@HuSharp HuSharp mentioned this pull request May 24, 2024
Merged
@HuSharp HuSharp mentioned this pull request May 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@niubell niubell niubell left review comments

@HuSharp HuSharp HuSharp approved these changes

@CabinfeverB CabinfeverB CabinfeverB approved these changes

@rleungx rleungx Awaiting requested review from rleungx

@nolouch nolouch Awaiting requested review from nolouch

Assignees
No one assigned
Labels
component/client Client logic. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@JmPotato @nolouch @niubell @CabinfeverB @HuSharp