JupyterHub Services url isn't always suitable for a health check - add a service property or not?

[consideRatio]

By configuring JupyterHub service's url to http://my-service-backend, users can visit https://my-jupyterhub.org/services/my-service to reach it. Sometimes this service have a dedicated path to make health checks, such as http://my-service-backend/api/health, but JupyterHub will check its health by default to the configured url that is also used to configure the /services/my-service proxied path. A single url is used for multiple purposes and that isn't great.

A minor issue has occurred for dask-gateway that needs to have a /services/dask-gateway path configured for users to access URLs like /services/dask-gateway/dashboards/..., but at the same time expects health checks to go to http://dask-gateway/api/health.

Would it be a good call to help handle these situations by one of the ideas below?

• To let JupyterHub accept an additional field to a service's configuration to specify the desired health check endpoint, separate from url if specified.
• To let JupyterHub accept an additional field to a service's configuration to opt out of having a health check against url.

Related

• Configurable properties of a JupyterHub Service, where url is one thing
• JupyterHub.service_check_interval (60 second is the default, 0 means no check for any service)

• jupyterhub/jupyterhub/app.py

  Lines 3490 to 3496 in 29bb4b8

  	# Check services health
  	self._check_services_health_callback = None
  	if self.service_check_interval:
  	self._check_services_health_callback = PeriodicCallback(
  	self.check_services_health, 1e3 * self.service_check_interval
  	)
  	self._check_services_health_callback.start()

[minrk]

I think both service.health_check_url (relative to service prefix) and service.disable_health_check make perfect sense to add as service config options.