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 probe endpoint for startup #101

Closed
weeco opened this issue Aug 4, 2020 · 0 comments
Closed

Add probe endpoint for startup #101

weeco opened this issue Aug 4, 2020 · 0 comments
Assignees
Labels

Comments

@weeco
Copy link
Contributor

weeco commented Aug 4, 2020

With Kubernetes 1.16 becoming more common I think it's wise to utilize the newly introduced startupProbe. To date Kowl exposes just one endpoint for probes, the /health endpoint. In order to make sure that Kowl doesn't receive traffic before it has connected to all brokers in the Kafka cluster we use the /health endpoint for the readiness probe.

Kowl is capable of handling transient connection issues (to Kafka) and therefore shouldn't be killed by any container orchestrator unless it's unrespsovie. Thus I propose to introduce another endpoint for probes:

  • /health - Returns static ok from the webserver. This is used to check whether the HTTP server is still alive
  • /startup - Returns ok if connectivity to (all) Kafka Brokers is given. This probe can be used for readiness probes but if possible a startup probe should be used in favour of using a readiness probe at all.
@weeco weeco added the backend label Aug 4, 2020
@weeco weeco added this to the 1.1 release milestone Aug 4, 2020
@weeco weeco self-assigned this Aug 4, 2020
@weeco weeco closed this as completed in a01d8fa Aug 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant