django-server-guardian-api 0.1.2

安装和使用

从pypi获得最新的稳定版本

pip install django-server-guardian-api

从github获取最新提交

pip install -e git+git://github.com/bitmazk/django-server-guardian-api.git#egg=server_guardian_api

将server_guardian_api添加到INSTALLED_APPS

INSTALLED_APPS=(...,'server_guardian_api',)

将server_guardian_apiurl添加到urls.py

urlpatterns=[url(r'^server-guardian-api/',include('server_guardian_api.urls')),]

作为一个简单的身份验证方法，添加安全令牌，如 将Django Server Guardian设置为SERVER_GUARDIAN_SECURITY_TOKEN

SERVER_GUARDIAN_SECURITY_TOKEN='asd0hb42t92-example-token-39gh1g3-91hfosj325'

添加作为端点度量的SERVER_GUARDIAN_PROCESSORS设置 是有定义的。

SERVER_GUARDIAN_PROCESSORS=('server_guardian_api.endpoints.mailer_mail','myapp.mymodule.myfunction',)

此设置中定义的函数必须返回以下字典 格式

{'status':'OK',# must be one of: "OK", "WARNING", "DANGER"'info':'additional text describing the status. e.g. type of error',}

这意味着，如果一切正常，您的api端点将返回如下内容

[{'label':'mail_queue','status':'OK','info':"No deferred email queued. That's great!",},{'label':'other_metric',...},]

贡献

如果您想参与此项目，请执行以下步骤

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-server-guardian-api
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch

为了运行测试，只需执行tox。这将安装两个新的 环境（适用于django 1.8和django1.9）并针对这两个环境运行测试 环境。