Tornado 支持编辑

将 Elastic APM 集成到您的 Tornado 项目只需要几个简单的步骤。

安装编辑

使用 pip 安装 Elastic APM 代理

$ pip install elastic-apm

或将 elastic-apm 添加到您项目的 requirements.txt 文件中。

设置编辑

要设置代理,您需要使用适当的设置对其进行初始化。

可以通过环境变量、应用程序的设置或作为初始化参数来配置设置。

您可以在配置页面中找到所有可用设置的列表。

要使用环境变量为您的应用程序初始化代理

import tornado.web
from elasticapm.contrib.tornado import ElasticAPM

app = tornado.web.Application()
apm = ElasticAPM(app)

要使用应用程序设置中的 ELASTIC_APM 配置代理

import tornado.web
from elasticapm.contrib.tornado import ElasticAPM

app = tornado.web.Application()
app.settings['ELASTIC_APM'] = {
    'SERVICE_NAME': '<SERVICE-NAME>',
    'SECRET_TOKEN': '<SECRET-TOKEN>',
}
apm = ElasticAPM(app)

用法编辑

配置代理后,它将自动跟踪事务并捕获 Tornado 中未捕获的异常。

通过调用 capture_exception 捕获任意异常

try:
    1 / 0
except ZeroDivisionError:
    apm.client.capture_exception()

使用 capture_message 记录通用消息

apm.client.capture_message('hello, world!')

性能指标编辑

如果您按照上述说明操作,则代理已在 tornado.web 中的基本 RequestHandler 类中安装了我们的检测。这将测量响应时间,以及所有受支持技术的详细性能数据。

由于 asyncio 驱动程序通常与其同步对应程序分开,因此所有驱动程序都需要特定的检测。目前对异步驱动程序的支持非常有限。

忽略特定路由编辑

您可以使用 TRANSACTIONS_IGNORE_PATTERNS 配置选项来忽略特定路由。给定的列表应该是与事务名称匹配的正则表达式列表

app.settings['ELASTIC_APM'] = {
    # ...
    'TRANSACTIONS_IGNORE_PATTERNS': ['^GET SecretHandler', 'MainHandler']
    # ...
}

这将忽略任何使用 GET SecretHandler 路由的请求以及任何包含 MainHandler 的请求。

支持的 Tornado 和 Python 版本编辑

您可以在我们的支持的技术页面上找到支持的 TornadoPython 版本列表。

Elastic APM 仅在使用 Python 3.7+ 时才支持 asyncio