基于regex过滤器的编校日志
logredactor的Python项目详细描述
日志编校器
根据用户传入的regex过滤器对python日志中的数据进行修订。
这同样适用于json日志格式,也适用于extra
参数中的嵌套数据。
示例
importreimportloggingimportlogredactor# Create a loggerlogger=logging.getLogger()# Add the redact filter to the logger with your custom filtersredact_patterns=[re.compile(r'\d+')]# if no `default_mask` is passed in, 4 asterisks will be usedlogger.addFilter(logredactor.RedactingFilter(redact_patterns,default_mask='xx'))logger.warning("This is a test 123...")# Output: This is a test xx...
python只在该记录器上应用过滤器,因此使用日志记录的任何其他文件都不会应用过滤器。要将此筛选器应用于所有记录器,请执行以下操作
importreimportloggingimportlogredactorfrompythonjsonloggerimportjsonlogger# Create a pattern to hide api key in url. This uses a _Positive Lookbehind_redact_patterns=[re.compile(r'(?<=api_key=)[\w-]+')]# Override the logging handler that you want redactedclassRedactStreamHandler(logging.StreamHandler):def__init__(self,*args,**kwargs):logging.StreamHandler.__init__(self,*args,**kwargs)self.addFilter(logredactor.RedactingFilter(redact_patterns))root_logger=logging.getLogger()sys_stream=RedactStreamHandler()# Also set the formatter to use json, this is optional and all nested keys will get redacted toosys_stream.setFormatter(jsonlogger.JsonFormatter('%(name)s%(message)s'))root_logger.addHandler(sys_stream)logger=logging.getLogger(__name__)logger.error("Request Failed",extra={'url':'https://example.com?api_key=my-secret-key'})# Output: {"name": "__main__", "message": "Request Failed", "url": "https://example.com?api_key=****"}