simple-channel-log 1.6.1

轻量高效的日志库，支持多级别日志记录、日志轮转、流水日志追踪及埋点日志功能，深度集成 Flask，FastAPI，Requests 以及 Unirest 框架。

simple-channel-log

轻量高效的日志库，支持多级别日志记录、日志轮转、流水日志追踪及埋点日志功能，深度集成 Flask，FastAPI，Requests 以及 Unirest 框架。

主要特性

• 📅 支持按时间轮转日志（天/小时/分钟等）
• 📊 提供多级别日志记录（DEBUG/INFO/WARNING/ERROR/CRITICAL）
• 🌐 内置 Flask，FastAPI 中间件记录请求/响应流水日志
• 📡 集成 Requests，Unirest 会话记录外部调用流水日志
• 🔍 智能处理长字符串截断（超过1000字符自动标记）
• 📁 自动创建分级日志目录结构
• 💻 支持终端输出与文件存储分离控制

安装

pip install simple_channel_log

快速入门

基础配置

# coding:utf-8
import simple_channel_log as log

# 初始化日志配置
log.__init__("<your_appname>", logdir="/app/logs")

# 初始化后可直接调用日志方法，日志将记录到参数 `logdir` 指定的目录中
log.debug("调试信息", extra_field="value")
log.info("业务日志", user_id=123)
log.warning("异常预警", error_code=500)
log.error("系统错误", stack_trace="...")

# 埋点日志
log.trace(
    user_id=123,
    action="purchase",
    item_count=2
)

Flask 流水日志

导入 Flask 库并初始化 simple_channel_log 即自动启用 Flask 流水日志，将自动记录每个接口的调用信息。

# coding:utf-8
import simple_channel_log
from flask import Flask, request, jsonify

app = Flask(__name__)


@app.get("/index")
def index():
    # 若要在日志中记录接口编码，你需要将接口编码传递给请求对象
    # request.method_code = "<method_code>"
    return jsonify({"msg": "ok"})


if __name__ == "__main__":
    # 初始化日志配置
    simple_channel_log.__init__("<your_appname>")

    # 启动后访问接口将自动记录流水日志
    app.run()

如果调用方已经将接口编码传递到请求头 request.headers["Method-Code"]，则会自动获取（优先级低）。

FastAPI 流水日志

导入 FastAPI 库并初始化 simple_channel_log 即自动启用 FastAPI 流水日志。

import uvicorn
import simple_channel_log
from fastapi import FastAPI, Request

app = FastAPI()

# 初始化日志配置
simple_channel_log.__init__("<your_appname>")


@app.get("/index")
async def index(request: Request):
    # 若要在日志中记录接口编码，你需要将接口编码传递给请求状态对象
    # request.state.method_code = "<method_code>"
    return {"msg": "ok"}


if __name__ == "__main__":
    # 启动后访问接口将自动记录流水日志
    uvicorn.run("main:app")

Requests 外部调用追踪

导入 requests 库并初始化 simple_channel_log 即自动启用 requests 外部调用追踪，将自动记录每个请求的调用信息。

# coding:utf-8
import requests
import simple_channel_log

# 初始化日志配置
simple_channel_log.__init__("<your_appname>")

# 发起请求后将自动记录外部流水日志
r = requests.get(
    "http://gqylpy.com/index",
    headers={
        # 若要在日志中记录被调用方的系统编码，你需要将被调用方的系统编码传递到请求头
        # "T-Code": "<tcode>",
        # 若要在日志中记录被调用方的接口编码，你需要将被调用方的接口编码传递到请求头
        # "Method-Code": "<method_code>"
    }
)

Unirest 外部调用追踪

导入 unirest 库并初始化 simple_channel_log 即自动启用 unirest 外部调用追踪，将自动记录每个请求的调用信息。

# coding:utf-8
import unirest
import simple_channel_log

# 初始化日志配置
simple_channel_log.__init__("<your_appname>")

# 发起请求后将自动记录外部流水日志
r = unirest.get(
    "http://gqylpy.com/index",
    headers={
        # 若要在日志中记录被调用方的系统编码，你需要将被调用方的系统编码传递到请求头
        # "T-Code": "<tcode>",
        # 若要在日志中记录被调用方的接口编码，你需要将被调用方的接口编码传递到请求头
        # "Method-Code": "<method_code>"
    }
)

详细配置

初始化参数

参数名	类型	默认值	说明
appname	str	必填	应用名称，以服务编码开头（小写），以下划线拼接
logdir	str	系统相关默认路径	日志存储根目录
when	str	'D'	轮转周期：W(周)/D(天)/H(时)/M(分)/S(秒)
interval	int	1	轮转频率
backup_count	int	7	历史日志保留数量（0=永久）
output_to_terminal	bool	False	启用后日志将同时输出到控制台