apicrud.health

health.py

created 28-mar-2020 by richb@instantlinux.net

Functions

healthcheck([app_name, service_name, tests, …])

Support for a standardized healthcheck endpoint - returns a health check report, with optional tests, in format recommended by Nadareishvili in RFC draft https://tools.ietf.org/id/draft-inadarei-api-health-check-04.html

apicrud.health.healthcheck(app_name='api', service_name='main', tests=None, model=None, releaseId=None, build_date=None, version=None)

Support for a standardized healthcheck endpoint - returns a health check report, with optional tests, in format recommended by Nadareishvili in RFC draft https://tools.ietf.org/id/draft-inadarei-api-health-check-04.html

Parameters
  • app_name (str) – the application name for description

  • service_name (str) – microservice name for serviceId

  • tests (list) – optional tests to run

  • model (obj) – schema model (usually AlembicVersion)

  • releaseId (str) – a release ID string

  • build_date (str) – build timestamp

  • version (str) – a version string

Returns

first element is pass or fail, second is response code

Return type

tuple