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

Add GRPC check #48

Closed
alexliesenfeld opened this issue Sep 16, 2022 · 3 comments
Closed

Add GRPC check #48

alexliesenfeld opened this issue Sep 16, 2022 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Good Hacktoberfest issue stale

Comments

@alexliesenfeld
Copy link
Owner

alexliesenfeld commented Sep 16, 2022

It would be useful to have a library of commonly used health checks. In the scope of this issue, a health check should be implemented that checks if a GRPC endpoint is reachable, e.g. by using a HealthClient instance from google.golang.org/grpc/health/grpc_health_v1 to retrieve its status and see if it is "serving" (I.e. HealthCheckResponse_SERVING).

A few constraints to keep things clean and simple:

  • The check should be added to the checks module that you can find in the development branch.
  • As with all health check functions of this library, the check implementation should support accepting and forwarding context.Context that is being passed to each health check function.
  • If the health check requires external external modules or other dependencies, the check should be implemented as a separate Go module(similarly how it is done for the tests, that require dependencies to other packages as well). This is required to avoid that when people import the base library, they also need to import all dependencies of all provided checks.
  • The check should have a README.md in its root directory that describes how to use it and maybe what to look out for.
  • You should provide a test that checks at least the happy path. If a docker container is required to properly test the check, the docker container can be added to the docker-compose.yaml file in the checks base package.

Should you have questions or require help, please join our discord chat room.

@alexliesenfeld alexliesenfeld added enhancement New feature or request good first issue Good for newcomers hacktoberfest Good Hacktoberfest issue labels Sep 16, 2022
@github-actions
Copy link

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Apr 18, 2023
@github-actions
Copy link

github-actions bot commented May 2, 2023

This issue was closed because it has been inactive for 14 days since being marked as stale.

@github-actions github-actions bot closed this as completed May 2, 2023
@nbgraham
Copy link

nbgraham commented Jan 9, 2024

Was the checks module removed?
It seems that it still exists on the development branch, but not main?
What is the status of the development branch?

https://github.com/alexliesenfeld/health?tab=readme-ov-file#compatibility-with-other-libraries

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Good Hacktoberfest issue stale
Projects
None yet
Development

No branches or pull requests

2 participants