zhangkun.logger

[loggers]
keys = root, gunicorn.access, gunicorn.error

[handlers]
keys = root, access, access_file, error_file , sentry

[formatters]
keys = common, json

[logger_root]
handlers = root

[logger_gunicorn.access]
handlers = access, access_file
qualname = gunicorn.access
level = INFO
propagate = 0

[logger_gunicorn.error]
handlers = error_file, sentry
qualname = gunicorn.error
level = ERROR
propagate = 0


[handler_root]
class = NullHandler
args = ()

[handler_access]
class = StreamHandler
formatter = common
args = (sys.stdout, )

[handler_sentry]
class = raven.handlers.logging.SentryHandler
level = ERROR
formatter = json
args = ("http://www.baidu.com",)

[handler_access_file]
level = INFO
class = logging.handlers.WatchedFileHandler
formatter = common
args = ('/data/log/web/logger_demo.access.log', 'a')

[handler_error_file]
level = INFO
class = logging.handlers.WatchedFileHandler
formatter = json
args = ('/data/log/web/logger_demo.error.log', 'a')

[formatter_common]
format = [%(levelname)s] [%(asctime)s] %(message)s
datefmt = %Y-%m-%d %H:%M:%S

[formatter_json]
format = [%(levelname)s] [%(asctime)s] %(message)s
datefmt = %Y-%m-%d %H:%M:%S
class = logger_demo.util.logger.JsonLogger
# -*- coding: utf-8 -*-

# 解决 MonkeyPatchWaring 提示
import gevent.monkey

gevent.monkey.patch_all()

import multiprocessing
from pathlib import Path

bind = "0.0.0.0:5000"
workers = multiprocessing.cpu_count() + 1
worker_class = "gevent"
worker_connections = 2000
threads = 8
timeout = 60

graceful_timeout = 5

deploy_dir = Path(__file__).parent.resolve()
chdir = str(deploy_dir.parent)

logconfig = str(deploy_dir / "logging.ini")
loglevel = 'INFO'

# 设置 nginx 代理下真是 remote_ip 地址 及 host 地址
access_log_format = '%({x-forwarded-for}i)s %(l)s ["%({http_host}e)s"] "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"'

def configure_logger(app):
    if app.config.get("GUNICORN_LOGGER_ENABLE", False):
        gunicorn_logger = logging.getLogger('gunicorn.error')
        app.logger.handlers = gunicorn_logger.handlers
        app.logger.setLevel(gunicorn_logger.level)
 sevice:
    enviornment:
      DOCKER_HOSTNAME:     （留空即可）
      DOCKER_HOSTIP:       (留空即可）

docker run -e DOCKER_HOSTNAME=$DOCKER_HOSTNAME DOCKER-HOSTIP=$DOCKER_HOSTIP         xxxxxxxxx
pip install -e git+https://gitlab+deploy-token-51:kapA9ypL_1wrpQXUzhcY@gitlab-inet.zkyouxi.com/zhouzhenfeng/zhangkun.logger.git@master#egg=zhangkun.logger
git+https://gitlab+deploy-token-51:kapA9ypL_1wrpQXUzhcY@gitlab-inet.zkyouxi.com/zhouzhenfeng/zhangkun.logger.git@master#egg=zhangkun.logger
# coding:utf8

from zhangkun.logger import JsonLogger， LoggerRecorder

# 增加元信息记录
JsonLogger.register_recorders(["cvm", "app", "client"])

class LoginException(LoggerRecorder):
    logType = "login" # logType 大类

    @classmethod
    def SigntureErr(cls, msg):
        return cls(msg, category="signture") # category 小类

    @classmethod
    def PermissionErr(cls, msg):
        return cls(msg, category="permission")
# coding:utf8

from flask import current_app
from logger_demo.util.logger import LoginException

# 第一种方式: 直接抛出 PermissionErr, 捕获处理
def foo(*args, **kwargs):
    try:
        raise LoginException.PermissionErr("用户不存在")
    except LoginException as e:
        current_app.logger.error(e, exc_info=True) # exc_info=True, 回溯错误异常

# 第二种方式: 生成 LoginException 对象
def foo(*args, **kwargs):
    userIds = ["user_123"]
    try:
        assert 'user_123' not in userIds, "该用户已封禁"
    except AssertionError as e:
        err = LoginException(category="permission", msg=e)
        current_app.logger.error(err, exc_info=False)

# 第三种方式: 直接记录错误
def foo(*args, **kwargs):
    userIds = ["user_123"]
    try:
        assert 'user_123' not in userIds, "该用户已封禁"
    except AssertionError as e:
        current_app.logger.error(LoginException.PermissionErr(e))

元信息定义如下:
# coding:utf8

from flask import request, has_request_context
from zhangkun.logger import JsonLogger, BaseRecorder

# 定义客户端抬头元信息
class ClientHeadersRecorder(BaseRecorder):
    @classmethod
    def handler(cls, record):
        if has_request_context():
            record.clientHeader = {
                "referrer": request.referrer
            }

# 注册到JsonLogger, CvmRecorder等内置元信息可采用字符串形式引入
# {"cvm": CvmRecorder， "app": AppRecorder, "client": ClientRecorder}
JsonLogger.register_recorders(["cvm", "app", "client", ClientHeadersRecorder])

# 如果只想调用 CvmRecord, 就只引入 CvmRecord
JsonLogger.register_recorders(["cvm"])

# coding:utf8

from zhangkun.logger import JsonLogger， LoggerRecorder

# 增加元信息记录
JsonLogger.register_recorders(["cvm", "app", "client"])

class SrvException(LoggerRecorder):
    logType = "srv" # logType 大类

    @classmethod
    def handler(cls, record):
        record.srv = {}
        if "srvParam" in record.__dict__: # 先判断srvParam存不存在
            srvParam = record.__dict__.pop("srvParam") # 删除srvParam
            record.srv.update({"srvParam": srvParam})

        if "srvResponse" in record.__dict__:
            srvResponse = record.__dict__.pop("srvResponse")
            record.srv.update({"srvResponse": srvResponse})
# coding:utf8

from flask import current_app
from logger_demo.util.logger import SrvException

def foo(*args, **kwargs):
    ...
    params = {"sign": "xxxx", "userId": "xxx"}
    err = SrvException(category="请求 xxx SRV", msg=e)
    current_app.logger.error(err, extra={"srvParam": params})