Version: 8.x (Current)

Doctor Service Usage

Doctor service results#

The Doctor service has two possible results:

  • 200: OK, all services are healthy and can do their job at 100%

    {
    "auth-service": {
    "name": "auth-validator",
    "status": "OK",
    "version": "1.2.0"
    },
    "a-beautiful-service": {
    "name": "a-beautiful-service",
    "status": "OK",
    "version": "0.1.7"
    }
    }
  • 503: KO, one or more services are not completely OK

    {
    "auth-service": {
    "name": "auth-validator",
    "status": "OK",
    "version": "1.2.0"
    },
    "microservice-gateway": {
    "error": {
    "type": "INVALID_STATUS_CODE",
    "statusCode": 404
    }
    },
    "mongodb-reader": {
    "error": {
    "type": "INVALID_STATUS_CODE",
    "statusCode": 404
    }
    }
    }

As can be seen from the above examples the result, regardless of the status code, will contain the /-/check-up response of each called service.