jeelo / audit-bundle
symfony2 和 doctrine ORM 的审计包,记录任何数据库变更
Requires
- php: >=5.4.0
- doctrine/orm: ^2.4
- symfony/framework-bundle: ^2.6|^3.0|^4.0|^5.0
Requires (Dev)
- php: >=5.6.0
- ext-pdo: *
- ext-pdo_sqlite: *
- data-dog/pager-bundle: ^0.2
- doctrine/doctrine-bundle: ^1.6
- doctrine/doctrine-fixtures-bundle: ^2.2
- doctrine/orm: ^2.5
- knplabs/knp-menu-bundle: ^2.0
- knplabs/knp-time-bundle: ^1.3
- phpunit/phpunit: ~4.7.0
- sensio/framework-extra-bundle: ^3.0.2
- symfony/symfony: ^3.0|^4.0|^5.0
README
此包为 doctrine ORM 相关的所有数据库变更创建审计日志
- 包括插入、更新及其差异和关系字段差异。
- 多对多关系变更,关联和解除关联操作。
- 如果 token 存储中有用户,则将其链接到日志中。
- 审计条目在 flush 期间与同一事务一起插入,如果失败,状态保持清洁。
基本上,如果您通过标准 ORM 操作管理这些日志条目,您可以跟踪这些日志条目中的任何变更。
注意:审计无法跟踪 DQL 或直接 SQL 更新或删除语句的执行。
安装
首先,使用 composer 安装它
composer require data-dog/audit-bundle
然后,将其添加到您的 AppKernel 包中。
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
...
new DataDog\AuditBundle\DataDogAuditBundle(),
...
);
...
}
最后,创建该包使用的数据库表
php app/console doctrine:migrations:diff
php app/console doctrine:migrations:migrate
使用 Doctrine Schema
php app/console doctrine:schema:update --force
演示
查看功能的最有效方法是查看实际演示。只需克隆该包并运行
make
访问 https://:8000/audit 查看日志操作。
演示应用程序源代码位于 example 目录中,它是一个基本的 symfony 应用程序。
使用方法
如果您运行架构更新或类似操作,audit 实体将自动映射。之后,所有数据库变更都将反映在审计日志中。
未审计的实体
有时,您可能不希望为特定实体创建审计日志条目。您可以通过在 config.yml
中的 unaudited_entities
配置键下列出这些实体来实现,例如
data_dog_audit:
unaudited_entities:
- AppBundle\Entity\NoAuditForThis
指定审计实体
有时,您可能只想为特定实体创建审计日志条目。您可以通过与未审计实体类似的方式来实现。您可以在 config.yml
中的 audited_entities
配置键下列出它们,例如
data_dog_audit:
audited_entities:
- AppBundle\Entity\AuditForThis
您可以指定已审计或未审计的实体。如果两者都指定,则仅考虑已审计的实体。
伪装
有时,您可能还想将责任归咎于 impersonator
用户而不是 impersonated
用户。您可以通过在 config.yml
中添加 blame_impersonator
配置键来实现,例如
data_dog_audit:
blame_impersonator: true
默认行为是将责任归咎于已登录用户,因此当未明确声明时,将忽略 impersonator
。
屏幕截图
许可证
审计包是免费使用的,并遵循MIT许可证