Django数据库日志记录项目教程

Django数据库日志记录项目教程

django-db-logger Django logging in database 项目地址: https://gitcode.com/gh_mirrors/dj/django-db-logger

1. 项目目录结构及介绍

本项目django-db-logger是一个用于将日志记录到数据库的Django应用。以下是项目的目录结构及文件介绍：

django-db-logger/
├── .github/              # GitHub工作流目录
│   └── workflows/        # 工作流文件
├── .gitignore            # Git忽略文件列表
├── LICENSE              # 项目许可证文件
├── MANIFEST.in           # 打包时包含的文件列表
├── README.rst           # 项目说明文件（reStructuredText格式）
├── build.sh              # 构建脚本
├── dev-requirements.txt # 开发环境依赖文件
├── manage.py            # Django管理脚本
├── setup.py             # 打包配置文件
├── test_manage.py       # 测试管理脚本
├── test_settings.py     # 测试配置文件
└── django_db_logger/     # 应用目录
    ├── admin.py          # Django管理界面配置
    ├── __init__.py       # 初始化文件
    ├── models.py         # 模型定义文件
    ├── tests.py          # 测试文件
    └── db_log_handler.py # 数据库日志处理器

• .github/workflows/：存放GitHub Actions工作流文件，用于自动化CI/CD流程等。
• .gitignore：指定Git应该忽略的文件和目录。
• LICENSE：项目所使用的许可证信息。
• MANIFEST.in：指定打包项目时应该包括哪些文件。
• README.rst：项目的详细说明文件，使用reStructuredText格式编写。
• build.sh：构建和打包项目的脚本。
• dev-requirements.txt：列出开发环境所需的依赖包。
• manage.py：Django项目管理脚本，用于运行各种管理任务。
• setup.py：项目的打包配置文件，用于构建和分发Python包。
• test_manage.py和test_settings.py：用于运行测试的管理脚本和配置文件。
• django_db_logger/：项目的主要应用目录，包含Django应用的各个组成部分。

2. 项目的启动文件介绍

项目的启动主要通过manage.py脚本进行。以下是启动项目的基本步骤：

1. 确保已经安装了Python 3.8+和Django 3.2+。
2. 安装项目依赖：pip install -r dev-requirements.txt。
3. 迁移数据库：python manage.py migrate。
4. 创建超级用户：python manage.py createsuperuser。
5. 启动Django开发服务器：python manage.py runserver。

执行以上步骤后，项目将在本地开发环境中启动，默认地址为http://127.0.0.1:8000/。

3. 项目的配置文件介绍

项目的配置主要通过settings.py文件进行。以下是一些重要的配置：

• INSTALLED_APPS：列出项目中安装的应用，应包含django_db_logger。
• LOGGING：日志配置部分，需要添加django_db_logger的处理器DatabaseLogHandler。
• DATABASES：数据库配置，根据实际情况配置数据库连接信息。

以下是一个简化的配置示例：

# settings.py示例

INSTALLED_APPS = [
    # ...
    'django_db_logger',
    # ...
]

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(asctime)s %(message)s'
        },
    },
    'handlers': {
        'db_log': {
            'level': 'DEBUG',
            'class': 'django_db_logger.db_log_handler.DatabaseLogHandler'
        },
    },
    'loggers': {
        'db': {
            'handlers': ['db_log'],
            'level': 'DEBUG',
        },
        'django.request': {
            'handlers': ['db_log'],
            'level': 'ERROR',
            'propagate': False,
        },
    },
}

确保在项目配置中正确设置了以上选项，以便日志可以被正确记录到数据库中。

django-db-logger Django logging in database 项目地址: https://gitcode.com/gh_mirrors/dj/django-db-logger