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

Define explicit health check resources for HTTP services #2758

Open
3 tasks
kyujin-cho opened this issue Aug 22, 2024 · 0 comments
Open
3 tasks

Define explicit health check resources for HTTP services #2758

kyujin-cho opened this issue Aug 22, 2024 · 0 comments
Assignees
Labels
type:feature Add new features
Milestone

Comments

@kyujin-cho
Copy link
Member

kyujin-cho commented Aug 22, 2024

Main idea

  • Create unified health check resource for every components
  • Disable logging access footage of health check resource
  • Extend health check API handler implementation to report connection status of each dependent components (redis, etcd, ...)

Though we already have HTTP resources dedicated for reporting its current health on some components (e.g. GET / for manager), for ease of management, let's create a unified health check method across every Backend.AI services with HTTP server. Key requirements are:

  • Health check request should be called by GET /health
  • Response should be formed as:
    • name of the component and its version in JSON format when Accept request header contains application/json
    • 204 No Content otherwise
  • Access log to the health check resource should not be posted since otherwise it will spam the whole log

Alternative ideas

No response

Anything else?

No response

@kyujin-cho kyujin-cho added the type:feature Add new features label Aug 22, 2024
@kyujin-cho kyujin-cho added this to the 24.03 milestone Aug 22, 2024
@kyujin-cho kyujin-cho changed the title Set up explicit health check resources for HTTP services Define explicit health check resources for HTTP services Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature Add new features
Projects
None yet
Development

No branches or pull requests

2 participants