DataDogAuditBundle安装与配置指南

DataDogAuditBundle安装与配置指南

DataDogAuditBundle Stores all database changes for doctrine ORM 项目地址: https://gitcode.com/gh_mirrors/da/DataDogAuditBundle

---

1. 项目目录结构及介绍

DataDogAuditBundle是一款专为基于Doctrine ORM的数据库变化记录设计的Symfony bundle。以下是其主要的目录结构及功能简介：

• src: 包含了bundle的核心代码，如审计日志的生成逻辑。

  • 此目录下的类定义了如何跟踪实体的变化，以及如何将这些变化存储到数据库中。

• docs: 提供了一些基础的文档说明，帮助开发者快速理解bundle的基本用法。

• tests: 单元测试和集成测试所在目录，确保bundle的功能正确无误。

• .editorconfig, .gitattributes, .gitignore: 版本控制相关配置，用于保持编码风格一致性和忽略不必要的文件。

• composer.json: 定义了项目的依赖和元数据，通过Composer进行管理。

• LICENSE: MIT许可证文件，说明了软件的许可条件。

• README.md: 项目的主要读我文件，包含了快速安装和基本使用的概览。

2. 项目的启动文件介绍

在Symphony框架下，并没有一个特定的“启动文件”来直接关联到这个bundle。然而，激活和初始化DataDogAuditBundle主要是通过以下几个步骤完成的：

• 启用Bundle：在你的应用的config/bundles.php文件中添加以下条目来启用它：

  return [
      // ...
      DataDog\AuditBundle\DataDogAuditBundle::class => ['all' => true],
  ];
  

• 数据库表创建：根据你的数据库迁移策略，选择使用Doctrine Migrations或直接更新schema来创建所需的审计表。例如，使用Migrations的方式：

  php bin/console doctrine:migrations:diff
  php bin/console doctrine:migrations:migrate
  

或者直接更新数据库模式：

php bin/console doctrine:schema:update --force

3. 项目的配置文件介绍

DataDogAuditBundle的配置通常是通过YAML格式的配置文件（如config/packages/data_dog_audit.yaml）来完成的。这允许你定制化哪些实体应该被审计、忽略，以及是否跟踪模拟用户的操作等。

示例配置文件基础结构可以是这样的：

data_dog_audit:
    # 指定不受审计的日志实体
    unaudited_entities: ['App\Entity\NoAuditForThis']
    # 或者指定仅审计的实体
    audited_entities: ['App\Entity\AuditForThis']
    # 是否将模拟（impersonator）用户设置为责任人
    blame_impersonator: true

• unaudited_entities: 列出不需要生成审计日志的实体类名。
• audited_entities: 明确列出需要审计的日志的实体类名，如果有冲突，这部分实体优先。
• blame_impersonator: 控制是否记录实际执行操作的用户（即使是在模拟其他用户的情况下）。

通过上述配置，你可以灵活地控制审计行为以适应不同的项目需求。记住，调整配置后需重启应用服务或刷新配置让改动生效。

这篇文档概括了DataDogAuditBundle的基本结构、启用过程以及关键配置点，旨在帮助开发者快速上手并高效利用此工具进行数据库变更追踪。

DataDogAuditBundle Stores all database changes for doctrine ORM 项目地址: https://gitcode.com/gh_mirrors/da/DataDogAuditBundle