Notebook: add /health_check for load balancers

Created on 28 Oct 2016 · 8Comments · Source: jupyter/notebook

Server Enhancement

Source

cailiang9

👍9 👀2

Most helpful comment

Do we have any updates on this? It would be really useful to have a /health endpoint which just simply returns status 200.

afaq404alam on 11 Jun 2018

👍17 👀1

All 8 comments

I'm not quite sure what this means - is it related to tmpnb or jupyterhub, perhaps?

takluyver on 3 Nov 2016

👀1

Thanks! we have our own docker spawner which is hard to integrate with tmpnb. So I run notebook directly and need a /health_check.

cailiang9 on 4 Nov 2016

👍1

I'm still not sure what you're after. What information would be in the response of /health_check? What are you trying to load balance? Sorry if this is obvious relative to tmpnb or something - I don't know much about that part of the project.

takluyver on 4 Nov 2016

👀1

Are you interest in a /health_check REST endpoint that a load balancer can hit to get the status of the notebook server?

ellisonbg on 23 Dec 2016

👀1 👍1

I +1 a /health endpoint. This is useful in also for some schedulers for example for a liveliness check for Kubernetes (https://lukemarsden.github.io/docs/user-guide/liveness/).

I personally like what Elasticsearch does: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html - but in general a return code of 200 would be good enough in most cases.