Skip to main content

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

Project description

simple-channel-log

Release Python Version License Downloads

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

主要特性

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

安装

pip install simple_channel_log

快速入门

基础配置

# coding:utf-8
import simple_channel_log as log

# 初始化日志配置
log.__init__("<your_appname>", "<your_syscode>", 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 流水日志

# coding:utf-8
import simple_channel_log as log

# 初始化日志配置
log.__init__(..., enable_journallog_in=True)

设置 enable_journallog_in=True 表示启用 Flask 流水日志,将自动记录每个接口的调用信息。

Requests 外部调用追踪

# coding:utf-8
import simple_channel_log as log

# 初始化日志配置
log.__init__(..., enable_journallog_out=True)

设置 enable_journallog_out=True 表示启用 Requests 外部调用追踪,将自动记录每个请求的调用信息。

详细配置

初始化参数

参数名 类型 默认值 说明
appname str 必填 应用名称,建议与CI配置一致
syscode str 必填 系统编码(大写)
logdir str 系统相关默认路径 日志存储根目录
when str 'D' 轮转周期:W(周)/D(天)/H(时)/M(分)/S(秒)
interval int 1 轮转频率
backup_count int 7 历史日志保留数量(0=永久)
output_to_terminal bool False 启用后日志将同时输出到控制台
enable_journallog_in bool False 启用Flask请求流水日志
enable_journallog_out bool False 启用Requests外部调用日志

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_channel_log-1.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simple_channel_log-1.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file simple_channel_log-1.0.tar.gz.

File metadata

  • Download URL: simple_channel_log-1.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for simple_channel_log-1.0.tar.gz
Algorithm Hash digest
SHA256 039cc3e6bc32c4948ecef954a3ddd21b62afa4eda2ae2b83a5d2416ef3b1614b
MD5 37d4032d80b59e27b5574d1cf6dc0632
BLAKE2b-256 3ae2e2e6aa831a7718fde139ce6c6bd3bb8a671696f90f1617f478c31f73a28b

See more details on using hashes here.

File details

Details for the file simple_channel_log-1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_channel_log-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cdccff5ad2c9012c3abde0ee10c9e990a937b778f2fe05c3dde2edce5227cba6
MD5 368eed803adc3d826f8d2e70dd2fa189
BLAKE2b-256 6098c4ac5f2780f42f544eb65678d7e43f68e299c1dc357414133aece7b1207d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page