py-healthcheck 1.9.0

健康检查

healthcheck是一个用来编写简单healthcheck函数的库，它可以 用于监视应用程序。可以在^{tt1}中使用$ app或Tornadoapp。它有助于断言您的依赖关系 已经启动并运行，应用程序可以响应http请求。 healthcheck函数可以通过用户定义的^{tt1}公开$ 路由以便可以使用外部监视应用程序（monit， nagios，Runscope等）检查您的 申请。

版本1.1中的新功能：healthcheck还提供了一个简单的烧瓶路径 查看有关应用程序环境的信息。默认情况下，这个 包括有关操作系统、python环境、 当前进程和应用程序配置。您可以自定义 包含部分，或将您自己的部分添加到输出中。

安装

pip install py-healthcheck

用法

下面是使用Flask：

fromflaskimportFlaskfromhealthcheckimportHealthCheck,EnvironmentDumpapp=Flask(__name__)health=HealthCheck()envdump=EnvironmentDump()# add your own check function to the healthcheckdefredis_available():client=_redis_client()info=client.info()returnTrue,"redis ok"health.add_check(redis_available)# add your own data to the environment dumpdefapplication_data():return{"maintainer":"Luis Fernando Gomes","git_repo":"https://github.com/ateliedocodigo/py-healthcheck"}envdump.add_section("application",application_data)# Add a flask route to expose informationapp.add_url_rule("/healthcheck","healthcheck",view_func=lambda:health.run())app.add_url_rule("/environment","environment",view_func=lambda:envdump.run())

要与Tornado一起使用，可以导入TornadoHandler：

importtornado.webfromhealthcheckimportTornadoHandler,HealthCheck,EnvironmentDumpapp=tornado.web.Application()health=HealthCheck()envdump=EnvironmentDump()# add your own check function to the healthcheckdefredis_available():client=_redis_client()info=client.info()returnTrue,"redis ok"health.add_check(redis_available)# add your own data to the environment dump or healthcheckdefapplication_data():return{"maintainer":"Luis Fernando Gomes","git_repo":"https://github.com/ateliedocodigo/py-healthcheck"}# ou choose where you want to output this informationhealth.add_section("application",application_data)health.add_section("version",__version__)envdump.add_section("application",application_data)# Add a tornado handler to expose informationapp.add_handlers(r".*",[("/healthcheck",TornadoHandler,dict(checker=health)),("/environment",TornadoHandler,dict(checker=envdump)),])

或者，您可以将所有这些设置在一起：

importtornado.webfromhealthcheckimportTornadoHandler,HealthCheck,EnvironmentDump# add your own check function to the healthcheckdefredis_available():client=_redis_client()info=client.info()returnTrue,"redis ok"health=HealthCheck(checkers=[redis_available])# add your own data to the environment dumpdefapplication_data():return{"maintainer":"Luis Fernando Gomes","git_repo":"https://github.com/ateliedocodigo/py-healthcheck"}envdump=EnvironmentDump(application=application_data)app=tornado.web.Application([("/healthcheck",TornadoHandler,dict(checker=health)),("/environment",TornadoHandler,dict(checker=envdump)),])

要运行所有检查功能，请向healthcheck发出请求 您指定的URL，如下所示：

curl "http://localhost:5000/healthcheck"

要查看环境数据，请检查指定的url 对于环境转储：

curl "http://localhost:5000/environment"

healthcheck类

# add check functionsdefaddition_works():if1+1==2:returnTrue,"addition works"else:returnFalse,"the universe is broken"

# add check functionsdefthrows_exception():bad_var=Nonebad_var['explode']

{"status":"failure","results":[{"output":"'NoneType' object has no attribute '__getitem__'","checker":"throws_exception","passed":false}]}

环境转储类

envdump=EnvironmentDump(include_python=False,include_os=False,include_process=False)

defapplication_data():return{"maintainer":"Luis Fernando Gomes","git_repo":"https://github.com/ateliedocodigo/py-healthcheck""config":app.config}envdump=EnvironmentDump()envdump.add_section("application",application_data)

学分

这个项目是由Runscope/healthcheck派生的。自1.3.1