search

yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
771 stars 143 forks source link

Modify health check endpoint and add HEAD method #958

Closed taeng0204 closed 4 weeks ago

taeng0204 commented 1 month ago

What this PR does / why we need it: In PR #952 , There were issues with existing health checks needing to support HEAD methods for UptimeRobot and overlapping with envoy's health check path. So I added the HEAD method and test code, and modified the health check endpoint.

Which issue(s) this PR fixes:

Fixes #832

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates introduce a plain HTTP health check endpoint to the server, enhancing monitoring capabilities by allowing both HTTP GET and HEAD requests. This functionality complements the existing gRPC health checks, providing a user-friendly method for uptime verification. The changes include new handlers and tests, ensuring robust validation for service health across different protocols.

Changes

Files Change Summary
server/rpc/httphealth/httphealth.go Introduced HTTP health check handler with NewHandler for service health checks using GET/HEAD.
server/rpc/server.go Modified NewServer to include integration of the new HTTP health check handler alongside gRPC.
test/integration/health_test.go Expanded health check tests to cover both gRPC and HTTP methods with new test functions.

Assessment against linked issues

Objective Addressed Explanation
Add Plain HTTP Health Check Endpoint (#832) ✅

🐰 In the meadow, where bunnies hop,
A health check blooms, no need to stop!
With GET and HEAD, we watch and play,
Uptime’s a joy, come what may!
Hooray for health, let’s cheer and sing,
Monitoring made easy, oh what joy it brings! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
krapie commented 1 month ago

@taeng0204 Could you please resolve the conflicts?

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 51.06%. Comparing base (80c6ea0) to head (505a40b).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #958 +/- ## ======================================= Coverage 51.06% 51.06% ======================================= Files 73 73 Lines 10782 10782 ======================================= Hits 5506 5506 Misses 4725 4725 Partials 551 551 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

krapie commented 1 month ago

@taeng0204 I think we should include that the health check is within Yorkie service to state that this health check is related to Yorkie, so /yorkie.v1.YorkieService/health or other names that includes /yorkie.v1.YorkieService will be better.

taeng0204 commented 1 month ago

@krapie In the existing grpc health check, there is a grpc.health.v1.Health that supports health checks for the yorkie service, admin service, and health check service, so why not http.health.v1.Health instead?

krapie commented 1 month ago

@taeng0204 That is also a good approach. When we proceeding with http.health.v1.Health, we need reconfigure yorkie cluster's routing conditions.

Note that we are using /yorkie.v1 for yorkie service route, /grafana for Grafana dashbaord, and /argocd for ArgoCD dashboard.

taeng0204 commented 1 month ago

@krapie thanks for the answer:) I've been thinking a lot about it, and I think it's better to integrate it into the existing /yorkie.v1. This code was written for a special situation for ncp lb, and I don't think it changes the existing system too much. I'll fix the code:)

taeng0204 commented 1 month ago

@krapie I tried modifying it like grpchealth's code, but I'm not sure if it's okay to use the variable names and comments as is.

// HealthV1ServiceName is the fully-qualified name of the v1 version of the health service.
const HealthV1ServiceName = "/yorkie.v1.YorkieService/health"