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

Make /api/debug/health return error when no backends are available #692

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

djshow832
Copy link
Collaborator

What problem does this PR solve?

Issue Number: close #689

Problem Summary:
When TiProxy starts, it may take some time to connect to PD and update the backend status. During this phase, no connections should be routed to this instance. So the HTTP API /api/debug/health should report an error when there's no available backends.

What is changed and how it works:

  • Add an interface NamespaceManager and test /api/debug/health with a mocked one.
  • NamespaceManager.Ready() returns true only when all the routers have at least one healthy backend.
  • /api/debug/health returns OK only when NamespaceManager.Ready() and the server is not closing.

Check List

Tests

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

Notable changes

  • Has configuration change
  • Has HTTP API interfaces change
  • Has tiproxyctl change
  • Other user behavior changes

Release note

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

- Make /api/debug/health return error when no backends are available

@ti-chi-bot ti-chi-bot bot requested review from bb7133 and xhebox September 27, 2024 07:20
@ti-chi-bot ti-chi-bot bot added the size/L label Sep 27, 2024
@djshow832
Copy link
Collaborator Author

/retest

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 67.56757% with 12 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@4243fb5). Learn more about missing BASE report.

Files with missing lines Patch % Lines
pkg/manager/namespace/manager.go 71.42% 6 Missing ⚠️
pkg/balance/router/router_score.go 75.00% 2 Missing and 1 partial ⚠️
pkg/balance/router/router_static.go 0.00% 2 Missing ⚠️
pkg/proxy/backend/handshake_handler.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #692   +/-   ##
=======================================
  Coverage        ?   69.88%           
=======================================
  Files           ?      105           
  Lines           ?    10015           
  Branches        ?        0           
=======================================
  Hits            ?     6999           
  Misses          ?     2523           
  Partials        ?      493           
Flag Coverage Δ
unit 69.88% <67.56%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

ti-chi-bot bot commented Sep 27, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: xhebox

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:

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

@ti-chi-bot ti-chi-bot bot added the lgtm label Sep 27, 2024
Copy link

ti-chi-bot bot commented Sep 27, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-09-27 08:06:50.06774843 +0000 UTC m=+1812479.808172369: ☑️ agreed by xhebox.

@ti-chi-bot ti-chi-bot bot added the approved label Sep 27, 2024
@ti-chi-bot ti-chi-bot bot merged commit 26c66bc into pingcap:main Sep 27, 2024
5 checks passed
@djshow832 djshow832 deleted the health branch September 27, 2024 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Report unhealthy when TiProxy loses connection to PD
3 participants