{"id":3500,"date":"2019-03-21T17:28:00","date_gmt":"2019-03-21T09:28:00","guid":{"rendered":"https:\/\/www.yewen.us\/blog\/?p=3500"},"modified":"2019-03-26T13:43:42","modified_gmt":"2019-03-26T05:43:42","slug":"playing-with-python-logging","status":"publish","type":"post","link":"https:\/\/www.yewen.us\/blog\/2019\/03\/playing-with-python-logging\/","title":{"rendered":"\u6298\u817e Python logging \u7684\u4e00\u4e9b\u8bb0\u5f55"},"content":{"rendered":"<p>Python \u81ea\u5df1\u6709\u6210\u719f\u7684\u65e5\u5fd7\u6a21\u5757 logging\uff0c\u4f7f\u7528\u4e2d\u9047\u5230\u4e00\u4e9b\u539f\u751f\u7ec4\u4ef6\u65e0\u6cd5\u6ee1\u8db3\u7684\u529f\u80fd\uff0c\u6216\u6709\u4e00\u4e9b\u4f7f\u7528\u65b9\u5f0f\u4e0a\u7684\u5751\uff0c\u8bb0\u5f55\u4e00\u4e0b<\/p>\n<h2>0. \u590d\u4e60\u4e00\u4e0b logging \u7684\u5b9e\u73b0<\/h2>\n<p>Python \u5b98\u7f51\u5bf9 logger flow \u7684\u5b9a\u4e49\u5982\u4e0b\u56fe\uff08\u6765\u6e90 <a href=\"https:\/\/docs.python.org\/3\/howto\/logging.html\" rel=\"noopener noreferrer\" target=\"_blank\">https:\/\/docs.python.org\/3\/howto\/logging.html<\/a>\uff09<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/docs.python.org\/zh-cn\/3\/_images\/logging_flow.png\" alt=\"Python logging flow\" \/><\/p>\n<p>\u6e90\u7801\u5728 python \u81ea\u5df1\u7684 <code>lib\/logging\/<\/code> \u4e0b\uff0c\u4e3b\u8981\u5185\u5bb9\u90fd\u5728 <code>__init__.py<\/code> \u91cc\uff0c\u5148\u6ce8\u610f\u4e0b\u51e0\u4e2a\u5b9a\u4e49<\/p>\n<ul>\n<li><code>Logger<\/code>\uff0c\u53ef\u4ee5\u6302\u8f7d\u82e5\u5e72\u4e2a <code>Handler<\/code>\uff0c\u53ef\u4ee5\u6302\u8f7d\u82e5\u5e72\u4e2a <code>Filter<\/code>\uff0c\u5b9a\u4e49\u8981\u54cd\u5e94\u7684\u547d\u540d\u7a7a\u95f4\uff0c\u548c\u65e5\u5fd7\u7ea7\u522b (1)<\/li>\n<li><code>Handler<\/code>\uff0c\u53ef\u4ee5\u6302\u8f7d\u4e00\u4e2a <code>Formatter<\/code>\uff0c\u53ef\u4ee5\u6302\u8f7d\u82e5\u5e72\u4e2a <code>Filter<\/code>\uff0c\u5b9a\u4e49\u4e86\u8981\u54cd\u5e94\u65e5\u5fd7\u7ea7\u522b (2)\uff0c\u548c\u8f93\u51fa\u65b9\u5f0f\uff08\u6d41\u3001\u6587\u4ef6\u7b49\uff09<\/li>\n<li><code>Filter<\/code>\uff0c\u8fc7\u6ee4\u5668\uff08\u5176\u5b9e\u4e5f\u53ef\u4ee5\u5728\u91cc\u9762\u641e\u66f4\u591a\u4e8b\u60c5\uff09<\/li>\n<li><code>Formatter<\/code>\uff0c\u6700\u7ec8\u65e5\u5fd7\u7684\u683c\u5f0f\u5316\u5b57\u7b26\u4e32<\/li>\n<li><code>LogRecord<\/code>\uff0c\u5355\u6761\u65e5\u5fd7\u7684\u7ed3\u6784\u4f53\uff0c\u6240\u6709\u4fe1\u606f\u90fd\u4f1a\u5b58\u5728\u8fd9\u91cc<\/li>\n<\/ul>\n<p>\u7136\u540e\u5bf9\u7740\u6d41\u7a0b\u56fe\u6765\u8bf4\uff0c\u4e3b\u6d41\u7a0b\u5982\u4e0b<\/p>\n<ol>\n<li>\u65e5\u5fd7\u6253\u5370\u8bf7\u6c42\u5230 <code>Logger<\/code> \u540e\uff0c\u5148\u5224\u5f53\u524d <code>Logger<\/code> \u662f\u5426\u8981\u5904\u7406\u8fd9\u4e2a\u7ea7\u522b\uff0c\u4e0d\u5904\u7406\u7684\u76f4\u63a5\u6254\u6389\uff08\u7ea7\u522b\u63a7\u5236 1\uff09<\/li>\n<li>\u751f\u6210\u4e00\u6761 <code>LogRecord<\/code>\uff0c\u4f1a\u628a\u5305\u62ec\u8c03\u7528\u6765\u6e90\u7b49\u4fe1\u606f\u90fd\u4e00\u8d77\u6253\u5305\u597d\uff0c\u4f20\u7ed9 <code>Logger<\/code> \u6302\u8f7d\u7684 <code>Filter<\/code> \u6328\u4e2a\u8fc7\u6ee4<\/li>\n<li>\u5982\u679c\u6709 <code>Filter<\/code> \u8fd4\u56de\u662f <code>False<\/code>\uff0c\u5219\u4e22\u5f03\u8fd9\u6761\u65e5\u5fd7<\/li>\n<li>\u5426\u5219\u4f20\u7ed9 <code>Logger<\/code> \u6302\u8f7d\u7684 <code>Handler<\/code> \u6328\u4e2a\u5904\u7406\uff08\u53f3\u4e0a\u89d2\u5b50\u56fe\uff09<\/li>\n<li>\u5982\u679c\u5f00\u542f\u4e86\u65e5\u5fd7\u5f80\u4e0a\u4f20\u9012\uff08<code>propagate<\/code>\uff0c\u4e0d\u77e5\u9053\u600e\u4e48\u7ffb\u8bd1\u66f4\u7cbe\u51c6\uff09\uff0c\u5219\u5224\u65ad\u5f53\u524d <code>Logger<\/code> \u662f\u5426\u6709\u7236 <code>Logger<\/code>\uff0c\u5982\u679c\u6709\u7684\u8bdd\uff0c\u76f4\u63a5\u5c06\u5f53\u524d <code>LogRecord<\/code> \u4f20\u7ed9\u7236 <code>Logger<\/code> \u4ece 4 \u5f00\u59cb\u5904\u7406\uff08\u8df3\u8fc7 1\/2\/3\uff0c\u6ce8\u610f\u6b64\u5904\u7ea7\u522b\u63a7\u5236 1 \u4f1a\u4e0d\u751f\u6548\uff0c\u7ed1\u5b9a\u5728\u7236 <code>Logger<\/code> \u4e0a\u7684 <code>Filter<\/code> \u4e5f\u4e0d\u6267\u884c\uff09<\/li>\n<\/ol>\n<p>\u53f3\u4e0a\u89d2\u7684\u5b50\u56fe\u662f <code>Handler<\/code> \u5185\u90e8\u7684\u6d41\u7a0b<\/p>\n<ol>\n<li>\u5224\u5f53\u524d <code>Handler<\/code> \u662f\u5426\u8981\u5904\u7406\u8fd9\u4e2a\u7ea7\u522b\uff0c\u4e0d\u5904\u7406\u7684\u76f4\u63a5\u6254\u6389\uff08\u7ea7\u522b\u63a7\u5236 2\uff09<\/li>\n<li>\u628a\u6536\u5230\u7684 <code>LogRecord<\/code> \u4ea4\u7ed9\u6302\u8f7d\u7684 <code>Filter<\/code> \u6328\u4e2a\u8fc7\u6ee4<\/li>\n<li>\u5982\u679c <code>Filter<\/code> \u6ca1\u6709\u963b\u6b62\uff0c\u6309\u6302\u8f7d\u7684 <code>Formatter<\/code> \u683c\u5f0f\u5316\u8f93\u51fa<\/li>\n<\/ol>\n<p>\u8fd9\u91cc\u9762\u6709\u4e00\u4e9b\u6bd4\u8f83\u597d\u73a9\u7684\u5730\u65b9<\/p>\n<h3>0.1 <code>LogRecord<\/code> \u7684\u751f\u6210<\/h3>\n<p>\u5728\u751f\u6210\u4e4b\u524d\u5176\u5b9e <code>Logger<\/code> \u5148\u5e72\u4e86\u4e24\u4ef6\u4e8b\uff0c\u4e00\u662f\u627e\u5230\u539f\u59cb\u7684\u8c03\u7528\u6e90\uff08\u6587\u4ef6\u540d <code>filename<\/code>\uff0c\u65b9\u6cd5\u540d <code>funcName<\/code>\uff0c\u884c\u53f7 <code>lineno<\/code>\uff09\uff0c\u4e8c\u662f\u6839\u636e\u53c2\u6570\u51b3\u5b9a\u662f\u5426\u9700\u8981\u83b7\u53d6\u8fd0\u884c\u4fe1\u606f <code>exc_info<\/code><\/p>\n<p>\u627e\u539f\u59cb\u8c03\u7528\u6e90\u5c31\u662f\u5728 Python \u7684\u8c03\u7528\u6808\u91cc\u4e00\u5c42\u4e00\u5c42\u5f80\u4e0a\u627e\uff0c\u76f4\u5230\u627e\u5230\u8c03\u7528\u6587\u4ef6\u4e0d\u662f\u5f53\u524d\u6587\u4ef6\uff08<code>**\/lib\/logging\/__init__.py<\/code>\uff09\u9000\u51fa\u3002\u5370\u8c61\u4e2d C\/C++ \u7684\u65e5\u5fd7\u662f\u76f4\u63a5\u7f16\u8bd1\u65f6\u628a\u5f53\u524d\u7684 <code>__line__<\/code> \u4ec0\u4e48\u7684\u5c55\u5f00\u5f97\u5230\uff0c\u5728 Python \u91cc\u8fd9\u4e48\u505a\u5e94\u8be5\u8fd8\u662f\u56e0\u4e3a Python \u662f\u89e3\u6790\u6027\u8bed\u8a00\u3002\u53e6\u5916\u53ef\u80fd\u8981\u6ce8\u610f\u7684\u662f\u8fd9\u91cc\u7684 <code>filename<\/code> \u5176\u5b9e\u662f\u6587\u4ef6\u7edd\u5bf9\u8def\u5f84\uff0c\u4f20\u5230 <code>LogRecord<\/code> \u91cc\u540e\u4f1a\u53d8\u6210 <code>pathname<\/code>\uff0c\u518d\u5206\u5272\u5f97\u5230\u6587\u4ef6\u540d <code>filename<\/code> \u548c\u6a21\u5757\u540d <code>module<\/code>\uff08\u8fd9\u4e2a\u5c31\u662f <code>filename<\/code> \u53bb\u6389\u540e\u7f00\uff09<\/p>\n<p>\u751f\u6210\u597d <code>LogRecord<\/code> \u540e\u8fd8\u4f1a\u628a\u4f20\u5165\u7684 <code>extra<\/code> \u5b57\u5178\u4e5f\u6302\u4e0a\u53bb\uff0c\u8fd9\u91cc\u4f1a\u9650\u5236 <code>extra<\/code> \u91cc\u7684\u5b57\u6bb5\u4e0d\u80fd\u548c <code>LogRecord<\/code> \u539f\u751f\u5b57\u6bb5\u51b2\u7a81\uff0c\u5426\u5219\u4f1a\u76f4\u63a5\u62a5\u9519<\/p>\n<h3>0.2 \u4e0d\u8981\u88ab\u540d\u5b57\u9a97\u4e86\u7684 <code>Filter<\/code><\/h3>\n<p>\u4ece\u540d\u5b57\u4e0a\u770b\uff0c<code>Filter<\/code> \u5e94\u8be5\u5c31\u662f\u4e00\u4e2a\u8fc7\u6ee4\u5668\uff0c\u5bf9\u8f93\u5165\u7684 <code>LogRecord<\/code> \u505a\u5224\u65ad\uff0c\u8fd4\u56de <code>True<\/code>\/<code>False<\/code> \u6765\u51b3\u5b9a\u6302\u8f7d\u7684 <code>Logger<\/code> \u6216 <code>Handler<\/code> \u662f\u5426\u8981\u5904\u7406\u5f53\u524d\u65e5\u5fd7\uff0c\u4f46\u662f\uff0c\u8fd9\u4e2a\u4e1c\u897f\u4e0d\u4ec5\u53ef\u4ee5\u8bfb <code>LogRecord<\/code>\uff0c\u8fd8\u53ef\u4ee5\u6539\u5199\uff0c\u8fd9\u91cc\u5c31\u6709\u5f88\u591a\u597d\u73a9\u7684\u4e8b\u60c5\u53d1\u751f\u4e86\uff08\u540e\u9762\u7684\u5f88\u591a\u4e8b\u60c5\u90fd\u662f\u5728\u8fd9\u91cc\u505a\u7684\uff09\uff0c\u800c\u4e14\u53ea\u8981\u88ab <code>Filter<\/code> \u6539\u8fc7\u7684 <code>LogRecord<\/code>\uff0c\u90fd\u8fd8\u4f1a\u7ee7\u7eed\u5f80\u540e\u4f20\u9012\u7ed9\u5176\u4ed6\u7684 <code>Filter<\/code>\/<code>Handler<\/code>\/<code>Logger<\/code><\/p>\n<h3>0.3 \u6ca1\u6709\u88ab\u63d0\u5230\u8fc7\u7684 adapter<\/h3>\n<p>\u5728 Python \u5b98\u65b9\u7684 logging Cookbook \u91cc\uff0c\u63d0\u5230\u52a0\u4e0a\u4e0b\u6587\u4fe1\u606f\u5df2\u5f00\u59cb\u63a8\u8350\u7684\u662f\u7528 <code>logging.LoggerAdapter<\/code> \u6765\u505a\uff0c\u8fd9\u4e2a\u4e1c\u897f\u5176\u5b9e\u662f\u5bf9 <code>Logger<\/code> \u591a\u4e86\u5c42\u5c01\u88c5\uff0c\u591a\u5305\u4e86\u4e00\u4e2a <code>extra<\/code> \u5b57\u5178\u8fdb\u53bb\uff0c\u5e76\u4e14\u63a5\u7ba1\u4e86 <code>Logger<\/code> \u7684 <code>process<\/code> \u65b9\u6cd5\uff0c\u5b9e\u9645\u7528\u8d77\u6765\u8fd9\u4e2a\u4e1c\u897f\u5e76\u4e0d\u597d\u7528\uff0c\u6240\u4ee5\u5728\u524d\u9762\u5b9a\u4e49\u90e8\u5206\u6ca1\u8bf4\u8fd9\u4e2a\uff0c\u5b98\u65b9\u7684\u56fe\u4e5f\u6ca1\u63d0\u8fd9\u5757<\/p>\n<h3>0.4 \u4e3a\u4ec0\u4e48 log \u8fd8\u662f\u8981\u7528 % \u6765\u683c\u5f0f\u5316<\/h3>\n<p>Python \u65b0\u4e00\u70b9\u7684\u7248\u672c\u90fd\u652f\u6301 <code>{}<\/code> \u683c\u5f0f\u5316\u5b57\u7b26\u4e32\uff0c\u5230 Python3.6 \u91cc\u66f4\u662f\u6709 literal template \u8fd9\u79cd\u4e0d\u8981\u592a\u65b9\u4fbf\u7684\u5b57\u7b26\u4e32\u8f93\u51fa\uff0c\u90a3\u4e3a\u4ec0\u4e48 log \u91cc\u8fd8\u662f\u575a\u6301\u8981\u7528 % \u52a0 args \u7684\u65b9\u5f0f\u6765\u5904\u7406\u5462\uff1f\u800c\u4e14 pylint \u7b49\u4e5f\u90fd\u4f1a\u5bf9\u5176\u4ed6\u683c\u5f0f\u5316\u65b9\u6cd5\u62a5\u8b66\u544a<\/p>\n<p>\u6ca1\u6709\u592a\u7ec6\u7a76\uff0c\u5927\u6982\u60f3\u4e86\u4e0b\u53ef\u80fd\u662f\u56e0\u4e3a\u8fd9\u4e00\u6574\u5957 Logger \u673a\u5236\u5176\u5b9e\u4e0d\u4ec5\u4ec5\u662f Python \u5728\u7528\uff0c\u5176\u4ed6\u8bed\u8a00\u4e5f\u6709\u5728\u7528\uff0c\u90a3\u4e48\u4fdd\u6301\u4e00\u81f4\u6027\u662f\u4e00\u4e2a\u539f\u56e0\u3002\u53e6\u5916\u8fd8\u6709\u67e5\u5230\u8bf4\u6cd5\u662f\u5982\u679c\u8fd9\u6761\u65e5\u5fd7\u7684\u7b49\u7ea7\u4e0d\u9700\u8981\u88ab\u5904\u7406\uff0c\u6216\u8005 <code>Filter<\/code> \u76f4\u63a5\u5c31\u62e6\u6389\u4e86\uff0c\u90a3\u4e48\u5c31\u4e0d\u4f1a\u8d70\u5230 <code>Formatter<\/code> \u90a3\u4e00\u6b65\uff0c\u53ef\u4ee5\u51cf\u5c11\u683c\u5f0f\u5316\u5f00\u9500\uff0c\u4e0d\u8fc7\u8fd9\u4e2a\u539f\u56e0\u4e5f\u6709\u7ad9\u4e0d\u4f4f\u811a\u7684\u5730\u65b9\uff0c\u5982\u679c\u67d0\u6761\u65e5\u5fd7\u786e\u5b9a\u8981\u88ab\u591a\u4e2a <code>Handler<\/code> \u5904\u7406\uff0c\u5728\u7528\u6237\u7aef\u683c\u5f0f\u5316\u5c31\u53ea\u7528\u505a\u4e00\u6b21\uff0c\u5728 <code>Formatter<\/code> \u91cc\u683c\u5f0f\u5316\u5c31\u6bcf\u4e2a <code>Handler<\/code> \u90fd\u8981\u91cd\u590d\u505a\u4e00\u6b21\u4e86<\/p>\n<h2>1. \u5bf9 logging \u589e\u52a0\u529f\u80fd<\/h2>\n<h3>1.1 \u589e\u52a0\u76f8\u5bf9\u8def\u5f84<\/h3>\n<p>\u539f\u751f <code>LogRecord<\/code> \u91cc\u53ea\u6709 <code>filename<\/code> \uff08\u6587\u4ef6\u540d\uff09\u548c <code>pathname<\/code> \uff08\u7edd\u5bf9\u8def\u5f84\uff09\uff0c\u7136\u800c <code>filename<\/code> \u592a\u77ed\uff0c\u6211\u4eec\u53ef\u80fd\u5728\u4e0d\u540c\u7684\u76ee\u5f55\u4e0b\u90fd\u6709\u540c\u540d\u6587\u4ef6\uff0c\u800c\u7edd\u5bf9\u8def\u5f84\u53c8\u592a\u957f\uff0c\u628a\u4e00\u5806\u6709\u7684\u6ca1\u7684\u90fd\u5e26\u4e0a\u6765\uff0c\u6240\u4ee5\u6211\u4eec\u60f3\u6253\u5370\u51fa\u76f8\u5bf9\u4e8e\u9879\u76ee\u7684\u76f8\u5bf9\u8def\u5f84<\/p>\n<p>\u4e00\u5f00\u59cb\u7528\u4e86\u5404\u79cd\u4eba\u8089\u9b54\u6539\uff0c\u5305\u62ec\u63a5\u7ba1\u6574\u4e2a <code>Logger<\/code> \u6765\u81ea\u5df1\u505a\uff0c\u540e\u6765\u53d1\u73b0\u53ef\u4ee5\u7b80\u5355\u52a0\u4e00\u4e2a <code>logging.Filter<\/code> \u6765\u89e3\u51b3\u3002\u524d\u9762\u63d0\u5230\u8fc7 <code>Filter<\/code> \u4e0d\u4ec5\u53ef\u4ee5\u8fc7\u6ee4\u51b3\u5b9a\u662f\u5426\u8981\u8f93\u51fa\u65e5\u5fd7\uff0c\u8fd8\u53ef\u4ee5\u6539\u4f20\u5165\u7684 <code>LogRecord<\/code>\uff0c\u8fd9\u6837\u5c31\u5f88\u7b80\u5355\u4e86\uff0c\u5728\u6211\u4eec\u7684 <code>Filter<\/code> \u91cc\uff0c\u8bb0\u5f55\u4e0b\u9879\u76ee\u7684\u6839\u8def\u5f84\uff08\u8fd9\u4e2a\u5f88\u5bb9\u6613\u901a\u8fc7\u5f53\u524d\u6587\u4ef6\u7684 <code>__file__<\/code> \u5f80\u4e0a\u6307\u5b9a\u5c42\u63a8\u51fa\u6765\uff09\uff0c\u7136\u540e\u5728 <code>LogRecord<\/code> \u6dfb\u52a0\u4e00\u4e2a <code>relpath<\/code> \u7684\u5c5e\u6027\uff0c\u53d6 <code>LogRecord.pathname<\/code> \u622a\u65ad\u6389\u524d\u9762\u975e\u9879\u76ee\u7684\u90e8\u5206\u5c31\u884c\u4e86<\/p>\n<h3>1.2 \u81ea\u5b9a\u4e49\u7684 <code>Filter<\/code> \u8fdb\u914d\u7f6e<\/h3>\n<p>\u6709\u4e86\u81ea\u5b9a\u4e49 <code>Filter<\/code> \u540e\uff0c\u8fd8\u9700\u8981\u80fd\u6302\u8f7d\u5230\u5bf9\u5e94\u7684 <code>Handler<\/code> \u6216 <code>Logger<\/code> \u4e0a<\/p>\n<p>\u8fd9\u91cc\u7565\u5751\u7684\u662f <code>logging.config.fileConfig<\/code> \u8fd9\u6837\u7684\u6587\u4ef6\u914d\u7f6e\u5e76\u4e0d\u652f\u6301\u81ea\u5b9a\u4e49 <code>Filter<\/code>\uff0c\u53ea\u80fd\u7528 <code>dictConfig<\/code>\u3002\u90a3\u4e48\u914d\u7f6e\u8981\u4e48\u5199 Python \u53d8\u6210\u539f\u751f dict\uff0c\u8981\u4e48\u7528 json \u5199\uff0c\u5728\u521d\u59cb\u5316\u914d\u7f6e\u7684\u5730\u65b9 <code>json.load<\/code> \u8bfb\u8fdb\u6765\u53d8\u6210 dict\u3002\u4ece\u300c\u914d\u7f6e\u6587\u4ef6\u5f52\u914d\u7f6e\u6587\u4ef6\u300d\u7684\u89d2\u5ea6\u8bf4\uff0c\u7528 json \u4f1a\u66f4\u5408\u9002\uff0c\u5982\u679c\u8003\u8651\u5230\u4e0d\u540c\u7684\u73af\u5883\u7528\u4e0d\u540c\u914d\u7f6e\uff0c\u7528\u57fa\u7c7b\u52a0\u7ee7\u627f\u5fae\u8c03\u7684\u65b9\u5f0f\uff0c\u53ef\u80fd\u5199 Python \u539f\u751f\u5b57\u5178\u4f1a\u66f4\u65b9\u4fbf<\/p>\n<h3>1.3 \u4fdd\u8bc1 <code>Formatter<\/code> \u5339\u914d <code>Filter<\/code><\/h3>\n<p>\u589e\u52a0\u7684 <code>relpath<\/code> \u53ef\u4ee5\u76f4\u63a5\u5728 <code>Formatter<\/code> \u91cc\u7528 <code>%(relpath)s<\/code> \u7684\u65b9\u5f0f\u8f93\u51fa\uff0c\u4f46\u662f\u8fd9\u91cc\u4e5f\u5f97\u4fdd\u8bc1\uff0c\u6709 <code>relpath<\/code> \u7684 <code>Formatter<\/code> \u62ff\u5230\u7684\u4e00\u5b9a\u662f\u88ab\u5904\u7406\u8fc7\u7684 <code>LogRecord<\/code>\uff0c\u4e0d\u7136\u5c31\u5d29\u4e86<\/p>\n<p>\u8003\u8651\u5230 <code>Formatter<\/code> \u662f\u4e00\u4e00\u7ed1\u5b9a\u5728 <code>Handler<\/code> \u4e0a\u7684\uff0c\u6240\u4ee5\u6211\u4e2a\u4eba\u8ba4\u4e3a\u6bd4\u8f83\u597d\u7684\u65b9\u6cd5\u662f\u5728 <code>Handler<\/code> \u91cc\u914d\u7f6e <code>Filter<\/code>\uff0c\u4fdd\u8bc1\u5982\u679c\u7528\u4e86\u81ea\u5b9a\u4e49\u5b57\u6bb5\u7684 <code>Formatter<\/code>\uff0c\u4e00\u5b9a\u8981\u52a0\u4e0a\u5bf9\u5e94\u7684 <code>Filter<\/code>\uff0c\u5c31\u7b97\u8fd9\u4e2a <code>Filter<\/code> \u5728\u591a\u4e2a <code>Handler<\/code> \u4e0a\u88ab\u591a\u6b21\u6267\u884c\uff0c\u6700\u591a\u589e\u52a0\u70b9\u6027\u80fd\u5f00\u9500\uff0c\u5e76\u4e0d\u4f1a\u5bf9\u7ed3\u679c\u4ea7\u751f\u6539\u53d8<\/p>\n<h3>1.4 \u6253\u5370 Flask \u8bf7\u6c42 ID<\/h3>\n<p>\u5bf9\u4e8e Flask \u5e94\u7528\uff0c\u6211\u4eec\u5e0c\u671b\u5bf9\u4e00\u6b21\u8bf7\u6c42\u6240\u6253\u7684\u65e5\u5fd7\u80fd\u6709\u4e00\u4e2a\u7edf\u4e00\u7684 <code>request_id<\/code> \u628a\u6240\u6709\u65e5\u5fd7\u4e32\u8d77\u6765\uff0c\u65b9\u4fbf\u8ffd\u67e5\u3002\u90a3\u4e48\u5728 Web \u8bf7\u6c42\u7684 <code>app.before_request<\/code> \u91cc\u5148\u52a0\u4e86\u4e2a <code>g.request_id<\/code>\uff0c\u628a <code>request.path<\/code> \u62fc\u4e0a\u4e00\u4e2a\u968f\u673a\u4e32\u8bb0\u5230\u4e0a\u4e0b\u6587 <code>g<\/code> \u91cc\uff0c\u7136\u540e\u5728 <code>logging.Filter<\/code> \u91cc\u5224\u65ad\u662f\u5426\u6709 app \u4e0a\u4e0b\u6587\uff0c\u6709\u7684\u8bdd\u53bb\u53d6\u8fd9\u4e2a\u5b57\u6bb5\uff0c\u5e76\u8ffd\u52a0\u5230 <code>LogRecord<\/code> \u91cc\uff0c\u540e\u9762\u5728 <code>Formatter<\/code> \u91cc\u76f4\u63a5\u5199 <code>%(request_id)s<\/code> \u5c31\u53ef\u4ee5\u8f93\u51fa\u4e86<\/p>\n<h3>5. \u6253\u5370 celery task id<\/h3>\n<p>\u540c\u4e0a\uff0c\u5bf9\u4e8e\u5f02\u6b65\u4efb\u52a1\uff0ccelery task \u81ea\u5df1\u5c31\u6709\u4e2a <code>request.id<\/code> \u5b57\u6bb5\uff0c\u76f4\u63a5\u5224\u65ad\u662f\u5426\u5b58\u5728\u4e0a\u4e0b\u6587\uff0c\u6478\u51fa\u6765\u6302\u5230 <code>LogRecord<\/code> \u4e0a\u5c31\u884c\u4e86<\/p>\n<h2>2. \u589e\u52a0\u6613\u7528\u6027<\/h2>\n<h3>2.1 <code>log_decorator<\/code><\/h3>\n<p>\u5f88\u591a\u65f6\u5019\u6211\u4eec\u5e0c\u671b\u77e5\u9053\u4e00\u4e2a\u65b9\u6cd5\u7684\u5165\u53c2\u548c\u8fd4\u56de\u503c\uff0c\u5982\u679c\u5728\u6bcf\u4e2a\u9700\u8981\u5904\u7406\u7684\u65b9\u6cd5\u524d\u540e\u90fd\u4eba\u8089\u5199\uff0c\u672a\u514d\u592a\u4e0d Pythonic\uff0c\u5f88\u81ea\u7136\u5c31\u60f3\u5230\u5bf9\u65b9\u6cd5\u8c03\u7528\u52a0\u4e0a\u88c5\u9970\u5668\uff0c\u81ea\u52a8\u6253\u8c03\u7528\u53c2\u6570\u548c\u8fd4\u56de\u7ed3\u679c<\/p>\n<p>\u5bf9\u4e8e\u600e\u4e48\u5199\u88c5\u9970\u5668\uff0c\u600e\u4e48\u6478\u88ab\u4fee\u9970\u65b9\u6cd5\u7684\u53c2\u6570\u540d\u548c\u503c\u7b49\uff0c\u4e4b\u524d\u5199\u7684\u51e0\u7bc7\u5173\u4e8e Python \u88c5\u9970\u5668\u7684 blog \u5df2\u7ecf\u5199\u7684\u5f88\u8be6\u7ec6\u4e86\uff0c\u6b64\u5904\u4e0d\u91cd\u590d<\/p>\n<p>\u552f\u4e00\u9700\u8981\u6ce8\u610f\u7684\u662f\u5982\u679c\u4e0d\u505a\u7279\u6b8a\u5904\u7406\uff0c\u6253\u5370\u7684\u65e5\u5fd7\u91cc\uff0c\u6587\u4ef6\u540d\u3001\u884c\u53f7\u3001\u65b9\u6cd5\u90fd\u662f <code>log_decorator<\/code> \u91cc\u6253\u65e5\u5fd7\u7684\u90a3\u884c\uff0c\u800c\u4e0d\u662f\u539f\u59cb\u65b9\u6cd5\u3002\u6240\u4ee5\u5728\u8fd9\u91cc\u9700\u8981\u5148\u6478\u5230\u539f\u59cb\u65b9\u6cd5\u7684\u6587\u4ef6\u8def\u5f84\u3001\u65b9\u6cd5\u540d\u3001\u884c\u53f7\uff0c\u5199\u5230 log \u7684\u53c2\u6570 <code>extra<\/code> \u91cc\u7528\u4e8e\u6784\u5efa <code>LogRecord<\/code>\uff0c\u8fd9\u91cc\u8fd8\u7279\u522b\u6ce8\u610f\u56e0\u4e3a <code>MakeRecord<\/code> \u7684\u65f6\u5019\u9650\u5236\u4e86\u4e0d\u5141\u8bb8\u8986\u76d6 <code>LogRecord<\/code> \u5df2\u6709\u7684\u5b57\u6bb5\uff0c\u6240\u4ee5\u8fd9\u91cc\u5fc5\u987b\u6539\u4e2a\u540d\u5b57\uff0c\u7b49\u5230 <code>Filter<\/code> \u91cc\u518d\u53bb\u5c1d\u8bd5\u770b\u6709\u6ca1\u6709\u81ea\u5df1\u52a0\u7684\u5b57\u6bb5\uff0c\u5982\u679c\u6709\u5219\u66ff\u6362\u5df2\u6709\u7684<\/p>\n<p>\u6211\u4eec\u5728\u5b9e\u9645\u5de5\u7a0b\u4e2d\u8fd8\u5bf9\u8fd9\u91cc\u505a\u4e86\u4e00\u4e9b\u4f18\u5316\uff0c\u652f\u6301\u4f20\u5165\u65b9\u6cd5\u6765\u5bf9\u5165\u53c2\u548c\u8fd4\u56de\u505a\u5904\u7406\u540e\u8f93\u51fa\uff0c\u7279\u522b\u662f\u5bf9\u590d\u6742\u7ed3\u6784\u5f88\u6709\u5fc5\u8981\uff0c\u53e6\u5916\u5bf9\u8fc7\u957f\u7684 tuple\/list\/set\/dict \u4e5f\u505a\u4e86\u622a\u65ad\u5904\u7406<\/p>\n<h3>2.2 <code>before_request<\/code> \/ <code>after_request<\/code><\/h3>\n<p>\u6709\u4e86 <code>log_decorator<\/code> \u53ef\u4ee5\u5bf9\u65b9\u6cd5\u7684\u5165\u53c2\u548c\u8fd4\u56de\u5f88\u5bb9\u6613\u8bb0\u5f55\uff0c\u90a3\u4e48\u5bf9\u4e8e Web \u8bf7\u6c42\uff0c\u5e94\u8be5\u4e5f\u53ef\u4ee5\u66f4\u5bb9\u6613\u7684\u505a\u8c03\u7528\u53c2\u6570\u548c\u8fd4\u56de\u503c\u7684\u8bb0\u5f55\u3002\u5bf9\u4e8e Flask \u5e94\u7528\uff0c\u53ef\u4ee5\u5728 <code>app<\/code> \u6216 <code>blueprint<\/code> \u4e0a\u5f80 <code>before_request<\/code> \u548c <code>after_request<\/code> \u91cc\u589e\u52a0\u6253\u65e5\u5fd7\u7684\u65b9\u6cd5\u6765\u8bb0\u5f55\u5165\u53c2\u548c\u8fd4\u56de<\/p>\n<p>\u6b64\u5904\u6682\u65f6\u6ca1\u6709\u5f88\u597d\u89e3\u51b3\u7684\u662f\u6587\u4ef6\u8def\u5f84\u3001\u65b9\u6cd5\u540d\u548c\u884c\u53f7\u8fd8\u662f\u8bb0\u5f55\u7684\u6253\u65e5\u5fd7\u8fd9\u4e2a\u65b9\u6cd5\u91cc\u8c03 log \u8bed\u53e5\u65f6\u7684\u6570\u636e\uff0c\u5e76\u4e0d\u662f\u6700\u7ec8\u5904\u7406 route \u7684\u65b9\u6cd5\uff0c\u6682\u65f6\u8fd8\u6ca1\u53bb\u7814\u7a76\u662f\u5426\u6709\u529e\u6cd5\u53ef\u4ee5\u5b9e\u73b0\uff0c\u6709 <code>request.path<\/code> \u53ef\u4ee5\u6839\u636e\u8def\u7531\u8868\u53bb\u67e5\uff0c\u5176\u5b9e\u4e5f\u8fd8\u597d<\/p>\n<h3>2.3 sentryHandler<\/h3>\n<p>\u5bf9\u4e8e\u7528\u4e86 sentry \u7684\u9879\u76ee\uff0c\u9664\u4e86\u629b\u5f02\u5e38\uff0c\u67d0\u4e9b\u65f6\u5019\u4e5f\u5e0c\u671b\u6709\u4e00\u4e9b\u9519\u8bef\u4fe1\u606f\u80fd\u88ab\u8bb0\u5f55\u5230 sentry \u4e0a\u3002\u6700\u571f\u7684\u65b9\u6cd5\u5c31\u662f\u751f\u6210\u4e00\u4e2a raven_client \u5b9e\u4f8b\uff0c\u7136\u540e <code>captureMessage<\/code> \u6216 <code>captureException<\/code><\/p>\n<p>\u5176\u5b9e sentry \u6709\u63d0\u4f9b <code>sentryHandler<\/code>\uff0c\u5c31\u662f\u4e00\u4e2a <code>logging.Handler<\/code>\uff0c\u76f4\u63a5\u914d\u5230 logging \u7684\u914d\u7f6e\u91cc\uff0c\u6302\u8f7d\u5230 <code>rootLogger<\/code> \u4e0a\uff0c\u521d\u59cb\u5316\u7684\u65f6\u5019\u5c31\u53ef\u4ee5\u81ea\u52a8\u6302\u8f7d\u4e0a\u53bb\uff0c\u540e\u9762\u8981\u7528\u7684\u65f6\u5019\u76f4\u63a5 <code>logger.error<\/code> \u6253\u65e5\u5fd7\u5c31\u662f\uff08\u4ec0\u4e48\uff1f\u4f60\u9700\u8981\u53ea\u6253 sentry \u4e0d\u6253 log\uff1f\u4f60\u90fd\u6253 sentry \u4e86\u8fd9\u4e48\u5927\u7684\u4e8b\u60c5\u90fd\u4e0d\u6253\u6761\u65e5\u5fd7\uff1f\u4e5f\u4e0d\u662f\u4e0d\u53ef\u4ee5\uff0c\u5355\u72ec\u914d\u4e2a logger \u53ea\u6302 sentryHandler \u5c31\u662f\uff0c\u4f46\u8fd8\u662f\u4e0d\u5efa\u8bae\u8fd9\u4e48\u505a\uff09<\/p>\n<p>\u5982\u679c\u9700\u8981\u6253\u8c03\u7528\u4fe1\u606f\uff0c\u5728 log \u65f6\u52a0\u4e0a\u53c2\u6570 <code>exc_info=True<\/code>\uff0c\u9700\u8981\u6253\u5806\u6808\u5c31\u52a0 <code>extra={\"stack\": True}<\/code>\uff0c\u6bd4\u81ea\u5df1\u4eba\u8089\u641e\u4e0d\u77e5\u9053\u9ad8\u5230\u54ea\u91cc\u53bb\u4e86<\/p>\n<p>\u66f4\u8be6\u7ec6\u7684\u8bf7\u89c1\u5b98\u65b9\u6587\u6863\uff1a<a href=\"https:\/\/docs.sentry.io\/clients\/python\/integrations\/logging\/\" rel=\"noopener noreferrer\" target=\"_blank\">https:\/\/docs.sentry.io\/clients\/python\/integrations\/logging\/<\/a><\/p>\n<h2>3. \u5173\u4e8e Sentry \u7684\u8865\u5145<\/h2>\n<h3>3.1 flask to sentry<\/h3>\n<p>\u5728 Flask \u5e94\u7528\u91cc\u7528 Sentry \u53ef\u4ee5\u53c2\u8003\u5b98\u65b9\u6587\u6863 <a href=\"https:\/\/docs.sentry.io\/clients\/python\/integrations\/flask\/\" rel=\"noopener noreferrer\" target=\"_blank\">https:\/\/docs.sentry.io\/clients\/python\/integrations\/flask\/<\/a> \uff0c\u4ece <code>raven.contrib.flask<\/code> \u91cc import \u4e00\u4e2a <code>Sentry<\/code> \u8fc7\u6765\u5c31\u884c\uff0c\u5b9e\u4f8b\u5316\u540e\u5728 <code>init_app<\/code> \u7684\u65f6\u5019\u6307\u5b9a\u4e0a\u5bf9\u5e94\u7684 sentry_dsn\uff0c\u8fd9\u6837\u5c31\u53ef\u4ee5\u7528\u8fd9\u4e2a sentry \u5b9e\u4f8b\u6765 <code>captureMessage<\/code> \u6216 <code>captureException<\/code><\/p>\n<p>\u5176\u5b9e\u8fd9\u91cc\u914d\u7f6e\u597d\u4e86\u66f4\u5927\u7684\u610f\u4e49\u662f\u5728 Flask \u5e94\u7528\u629b\u4e86\u6ca1\u6709\u4eba\u63a5\u7684\u5f02\u5e38\u65f6\u80fd\u5f80 sentry \u6253\u5f02\u5e38\u62a5\u544a\uff0c\u8fd9\u4e2a\u5730\u65b9\u4e00\u5f00\u59cb\u6211\u914d\u7f6e\u597d <code>sentryHandler<\/code> \u5230 <code>logging.rootLogger<\/code> \u540e\u5f97\u610f\u5fd8\u5f62\u7684\u628a\u521d\u59cb\u5316 Sentry \u7ed9\u53bb\u6389\u4e86\uff0c\u7136\u540e\u5c31\u6355\u83b7\u4e0d\u5230\u5f02\u5e38\u4e86\uff0c\u5f04\u660e\u767d\u600e\u4e48\u56de\u4e8b\u540e\u8001\u8001\u5b9e\u5b9e\u52a0\u56de\u6765\uff0c\u6700\u540e\u5f02\u5e38\u6355\u83b7\u8d70 <code>raven.contrib.flask.Sentry<\/code>\uff0c\u65e5\u5fd7\u8d70 <code>rootLogger.sentryHandler<\/code>\uff0c\u5404\u884c\u5176\u662f<\/p>\n<p>\u8fd9\u91cc\u8fd8\u53d1\u73b0\u4e86\u4e2a\u7279\u522b\u6d6a\u7684\u64cd\u4f5c\uff0c\u65e2\u7136\u6211\u4eec\u5728 <code>logging.rootLogger<\/code> \u4e0a\u5df2\u7ecf\u914d\u597d\u4e86 sentry_dsn\uff0c\u90a3\u662f\u4e0d\u662f\u5c31\u6709\u73b0\u6210\u7684 raven_client \u53ef\u4ee5\u7528\u5462\uff1f\u5b9e\u9645\u4e0a\u662f\u53ef\u4ee5\u7684\u2026 \u53c2\u8003\u4e0b\u65b9\u4ee3\u7801\uff0c\u521d\u59cb\u5316\u7684\u65f6\u5019\u76f4\u63a5\u5199 <code>Sentry(app, client)<\/code> \u5c31\u884c\uff0c\u91cc\u9762\u4f1a\u81ea\u52a8\u5b8c\u6210 <code>init_app<\/code> \u7684\u64cd\u4f5c\u7684<\/p>\n<pre class=\"brush: python; title: ; notranslate\" title=\"\">\ndef getRavenClient():\n    _logger = logging.getLogger()\n    for handler in _logger.handlers:\n        if isinstance(handler, SentryHandler) and handler.client.is_enabled():\n            return handler.client\n    return None\n<\/pre>\n<h3>3.2 celery to sentry<\/h3>\n<p>\u540c\u6837\uff0c\u5bf9\u4e8e celery \u5f02\u6b65\u4efb\u52a1\uff0c\u4e5f\u53ef\u4ee5\u53c2\u8003\u5b98\u65b9\u6587\u6863 <a href=\"https:\/\/docs.sentry.io\/clients\/python\/integrations\/celery\/\" rel=\"noopener noreferrer\" target=\"_blank\">https:\/\/docs.sentry.io\/clients\/python\/integrations\/celery\/<\/a> \u6765\u914d\u7f6e\u5f80 Sentry \u6253\u65e5\u5fd7\u6216\u6355\u83b7\u5f02\u5e38\uff0c\u56e0\u4e3a\u6211\u4eec\u5df2\u7ecf\u5728 <code>logging.rootLogger<\/code> \u4e0a\u914d\u8fc7 <code>sentryHandler<\/code>\uff0c\u6240\u4ee5\u5b98\u65b9\u6587\u6863\u91cc\u7684 <code>register_logger_signal<\/code> \u53ef\u4ee5\u5ffd\u7565\uff0c\u53ea\u8981\u4ece <code>ravan.contrib.celery<\/code> \u91cc import \u8fd9\u4e2a <code>register_signal<\/code> \u65b9\u6cd5\u5e76\u521d\u59cb\u5316\u5c31\u884c\uff0c\u521d\u59cb\u5316 client \u4e00\u6837\u53ef\u4ee5\u53c2\u8003\u4e0a\u9762\u4ece <code>rootLogger<\/code> \u91cc\u53bb\u6478<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Python \u81ea\u5df1\u6709\u6210\u719f\u7684\u65e5\u5fd7\u6a21\u5757 logging\uff0c\u4f7f\u7528\u4e2d\u9047\u5230\u4e00\u4e9b\u539f\u751f\u7ec4\u4ef6\u65e0\u6cd5\u6ee1\u8db3\u7684\u529f\u80fd\uff0c\u6216\u6709\u4e00\u4e9b\u4f7f\u7528\u65b9\u5f0f\u4e0a\u7684 [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_post_was_ever_published":false},"categories":[7],"tags":[689,688,686,127,687],"class_list":["post-3500","post","type-post","status-publish","format-standard","hentry","category-tech-notes","tag-celery","tag-flask","tag-logging","tag-python","tag-sentry"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p4aR5e-Us","_links":{"self":[{"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/posts\/3500","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/comments?post=3500"}],"version-history":[{"count":13,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/posts\/3500\/revisions"}],"predecessor-version":[{"id":3514,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/posts\/3500\/revisions\/3514"}],"wp:attachment":[{"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/media?parent=3500"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/categories?post=3500"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.yewen.us\/blog\/wp-json\/wp\/v2\/tags?post=3500"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}