Django进阶 ----日志管理

1. 说明

每一条日志信息记录了一个事件的发生，包括了：

• 事件发生时间
• 事件发生位置
• 事件的严重程度–日志级别
• 事件内容

日志级别分为：

• DEBUG：用于调试目的的低级系统信息
• INFO：一般系统信息
• WARNING：已发生的小问题的警告信息。
• ERROR：已发生的主要问题的错误信息。
• CRITICAL：已发生的严重问题的信息。

2. logging 日志模块

Django的日志模块其实就是python的 logging 模块，由4部分组成：

• Logger 记录仪：生成和记录每条日志信息及级别
• Handler 处理程序: 根据日志信息级别交由相应处理程序处理（比如生成 log 文件或发送邮件）
• Filters 过滤器：日志交由处理程序处理前需要满足的过滤条件(比如Debug=True或False)
• Formaters 格式化程序：决定每条日志的打印输出格式，可以有完整版的，也有简单版的

import logging
# 获得logger实例
logger = logging.getLogger(__name__)
def my_view(request, arg1, arg2):
    ...
    if error_happens:
        # 如发生错误，记录错误信息
        logger.error('Something went wrong!')

• 配置 settings.py

# 给ADMINS发送邮件需要配置
ADMINS = (
 ('admin_name','your@gmail.com'),
)
MANAGERS = ADMINS

# 创建log文件的文件夹
LOG_DIR = os.path.join(BASE_DIR, "logs")
if not os.path.exists(LOG_DIR): 
    os.mkdir(LOG_DIR) 

# 基本配置，可以复用的
LOGGING = {
    "version": 1,
    "disable_existing_loggers": False, # 禁用已经存在的logger实例
    "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
    "formatters": { # 定义了两种日志格式
        "verbose": { # 详细
            "format": "%(levelname)s %(asctime)s %(module)s "
            "%(process)d %(thread)d %(message)s"
        },
        'simple': { # 简单
            'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
        },
    },
    "handlers": { # 定义了三种日志处理方式
        "mail_admins": { # 只有debug=False且Error级别以上发邮件给admin
            "level": "ERROR",
            "filters": ["require_debug_false"],
            "class": "django.utils.log.AdminEmailHandler",
        },
        'file': { # 对INFO级别以上信息以日志文件形式保存
            'level': "INFO", 
            'class': 'logging.handlers.RotatingFileHandler',  # 滚动生成日志，切割。RotatingFileHandler是需要重点了解的
            'filename': os.path.join(LOG_DIR,'django.log'),  # 日志文件名
            'maxBytes': 1024 * 1024 * 10,  # 单个日志文件最大为10M
            'backupCount': 5,  # 日志备份文件最大数量
            'formatter': 'simple', # 简单格式
            'encoding': 'utf-8', # 防止中文乱码
        },
        "console": { # 打印到终端console
            "level": "DEBUG",
            "class": "logging.StreamHandler",
            "formatter": "verbose",
        },
    },
    "root": {"level": "INFO", "handlers": ["console"]},
    "loggers": {
        "django.request": { # Django的request发生error会自动记录
            "handlers": ["mail_admins"],
            "level": "ERROR",
            "propagate": True,  # 向不向更高级别的logger传递
        },
        "django.security.DisallowedHost": { # 对于不在 ALLOWED_HOSTS 中的请求不发送报错邮件
            "level": "ERROR",
            "handlers": ["console", "mail_admins"],
            "propagate": True,
        },
    },
}

3. loguru 日志模块

• pip 安装好 loguru 后在Django项目中可以直接在视图中使用，省去复杂的配置，非常便捷。它定义了日志文件名、每条记录的格式、日志文件的轮替以及过滤级别

from loguru import logger
 
logger.add("django.log", format="{time:YYYY-MM-DD at HH:mm:ss} | {level} | {message}", rotation="100 MB", filter="", level="INFO", encoding='utf-8')
def my_view(request, arg1, arg2):
    ...
    if error_happens:
        logger.error("Something went wrong")

4. sentry 日志模块

Sentry 为多种语言以及各种框架(包括Django)提供了SDK。只需几行配置， sentry 就会监控你的程序运行，自动收集错误和异常以及上下文数据，发送到 sentry 的服务器上，开发者可以通过 sentry 的web端 实时查看错误和异常

• 1.安装sentry-sdk

  pip install --upgrade sentry-sdk
  

• 2.注册登录sentry，创建Django项目，获取一个公共密钥PublicKey地址
  

• 3.修改 settings.py

  import sentry_sdk
  from sentry_sdk.integrations.django import DjangoIntegration
  
  sentry_sdk.init(
      dsn="https://examplePublicKey@o0.ingest.sentry.io/0", # 你的PublicKey
      integrations=[DjangoIntegration()],
  
      # Set traces_sample_rate to 1.0 to capture 100%
      # of transactions for performance monitoring.
      # We recommend adjusting this value in production,
      traces_sample_rate=1.0,
  
      # If you wish to associate users to errors (assuming you are using
      # django.contrib.auth) you may enable sending PII data.
      send_default_pii=True,
  
      # By default the SDK will try to use the SENTRY_RELEASE
      # environment variable, or infer a git commit
      # SHA as release, however you may want to set
      # something more human-readable.
      # release="myapp@1.0.0",
  )