Health checker OOB about loopback-next HOT 7 CLOSED

Here is what I meant:

1. HealthCheck is an interface/mixin that a controller can choose to implement
2. The health check operation will be mount to /myController/healthcheck
3. The implementation of heathcheck method can be custom. The backing datasource can provide a default impl based on ping.

from loopback-next.

I think what I want is dataSource.ping … basically I want an endpoint to confirm that a db exists before running local tests, if that make sense? An example of how to use dataSource.ping to check if the underlying db is healthy would be great.

from loopback-next.

cc @raymondfeng

from loopback-next.

"@simonho @erin.mckean Health check should be a mixin that models can opt in" as per @raymondfeng

from loopback-next.

-1 for a model mixin... Models should just be plain objects. This should be one or both of:

// a
let heartbeat = await repository.ping()
// b
heartbeat = await dataSource.ping()

That being said... its not just about datasources... thats a naive way to look at this. Health means the entire health of the API. Eg. GET /health this could do something like:

public getHealth() : Array<HeartBeat> {
  for(binding of app.find('dataSources.*')) {
    yield (await binding.resolve().ping());
  }
}

from loopback-next.

+1 for a controller mixin

from loopback-next.

I am closing this issue because we are not going to have time to work on this in the next 6-9 months. However, we are happy to accept a pull request contributing this feature.

from loopback-next.