eruvanos / openbrokerapi

A python package for the V2 CF Service Broker API
https://openbrokerapi.readthedocs.io/
MIT License
35 stars 19 forks source link

Provide the service broker with a "health check" endpoint for monitoring purpose #61

Open redorff opened 5 years ago

redorff commented 5 years ago

In critical environments, monitoring is a requirement.

So this service broker framework could offer an unauthenticated route like /status.

This route would be bound to a status() method in the ServiceBroker class. By default, the status method would always return "OK".

Then, any developer using the framework could inherit or overload this status method for his own needs.

eruvanos commented 4 years ago

Update: My idea is to document, how to implement this using project specific code.

The implementation for a broker that may provide multiple services in one would require a status response that can not be covered with a simple boolean.

Open for discussions :)