安装¶

接下来的文档是假设你拥有一个 Exceptional 账号。用 pip 安装这个扩展是简单的:

$ pip install Flask-Exceptional

或者用 easy_install 安装它:

$ easy_install Flask-Exceptional

快速入门¶

在安装 Flask-Exceptional 后，所有你必须要做的就是创建一个 Flask 应用程序，配置 Exceptional API 密钥，接着创建 Exceptional 对象。正是这样的简单:

from flask import Flask
from flask.ext.exceptional import Exceptional

app = Flask(__name__)
app.config["EXCEPTIONAL_API_KEY"] = "exceptional_forty_character_unique_key"
exceptional = Exceptional(app)

你的应用程序是被配置成基于云的错误监控！你可以通过调用 Exceptional.test() 方法来验证配置是否正常工作:

Exceptional.test(app.config)

请翻阅接下来的章节获取更多关于 Flask-Exceptional 可用的配置项的细节。

配置¶

Flask-Exceptional 中存在如下的配置项:

API¶

class flask.ext.exceptional.Exceptional(app=None)¶

Extension for tracking application errors with Exceptional. Errors are not tracked if DEBUG is True. The application will log a warning if no EXCEPTIONAL_API_KEY has been configured.

Parameters:	app – Default None. The Flask application to track errors for. If the app is not provided on creation, then it can be provided later via init_app().

static context(data=None, **kwargs)¶

Add extra context data to the current tracked exception. The context data is only valid for the current request. Multiple calls to this method will update any existing context with new data.

Parameters:	data – Default None. A dictionary of context data. kwargs – A series of keyword arguments to use as context data.

init_app(app)¶

Initialize this Exceptional extension.

Parameters:	app – The Flask application to track errors for.

static publish(config, traceback)¶

Publish the given traceback directly to Exceptional. This method is useful for tracking errors that occur outside the context of a Flask request. For example, this may be called from an asynchronous queue.

Parameters:	config – A Flask application configuration object. Accepts either flask.Config or the object types allowed by flask.Config.from_object(). traceback – A werkzeug.debug.tbtools.Traceback instance to publish.

static test(config)¶

Test the given Flask configuration. If configured correctly, an error will be tracked by Exceptional for your app. Unlike the initialized extension, this test will post data to Exceptional, regardless of the configured DEBUG setting.

Parameters:	config – The Flask application configuration object to test. Accepts either flask.Config or the object types allowed by flask.Config.from_object().

Changelog¶