请求ID 1.0.1

安装

您可以使用pip安装request-id软件包。

$ pip install request-id

使用PasteDeploy进行配置

更新您的应用程序INI，使其在带有request-id过滤器的管道中运行

[app:myapp]
use = egg:myapp

[filter:request-id]
use = egg:request-id
format = {status} {REQUEST_METHOD:<6} {REQUEST_PATH:<60} {REQUEST_ID}

[pipeline:main]
pipeline =
  request-id
  myapp

[loggers]
keys = translogger

[handlers]
keys = translogger

[formatters]
keys = minimal

[logger_translogger]
level = INFO
handlers = translogger
qualname = request_id
propagate = 0

[handler_translogger]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = minimal

[formatter_minimal]
format = %(message)s

在代码中进行配置

创建一个RequestIdMiddleware对象，并将其与您的WSGI应用组合

from request_id import RequestIdMiddleware
from wsgiref.simple_server import make_server

def app(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/plain')])
    yield 'Hello World\n'

app = RequestIdMiddleware(
    app,
    format='{status} {REQUEST_METHOD:<6} {REQUEST_PATH:<60} {REQUEST_ID}',
)

if __name__ == '__main__':
    server = make_server('0.0.0.0', 8080, app)
    server.serve_forever()

访问request_id

request_id存储在请求的environ字典中，可以使用request_id.get_request_id(request)在任何可用位置访问它，其中request是webob.request.Request的一个实例。

设置

logger_name

将日志输出传递给Python stdlib logger的名称。默认：request_id

logging_level

将请求信息输出到Python stdlib logging级别的名称。默认：INFO

格式

使用PEP-3101字符串格式语法的格式化字符串。可能的选项有

• REQUEST_ID

• REMOTE_ADDR

• REMOTE_USER

• REQUEST_METHOD

• REQUEST_URI

• REQUEST_PATH

• HTTP_HOST

• HTTP_VERSION

• HTTP_REFERER

• HTTP_USER_AGENT

• 时间

• 持续时间

• 字节

• 状态

默认：'{REMOTE_ADDR} {HTTP_HOST} {REMOTE_USER} [{时间}] "{REQUEST_METHOD} {REQUEST_URI} {HTTP_VERSION}" {状态} {字节} {持续时间} "{HTTP_REFERER}" "{HTTP_USER_AGENT}" - {REQUEST_ID}

source_header

如果不为None，则将从请求的此头中提取request_id。这在上游系统设置了一个您想在WSGI应用中使用的请求标识符时非常有用。默认：None

exclude_prefixes

一个基于request.path_info的URL路径列表（用空格或换行符分隔），要忽略这些路径。路径应有一个前置的/以便正确匹配。默认：None

致谢

此代码在Paste的translogger middleware上进行了大量借鉴。