damienharper/auditor

缺失的审计日志库。


README

Latest Stable Version Latest Unstable Version auditor 3.x CI Scrutinizer Code Quality codecov License Total Downloads Monthly Downloads Daily Downloads

auditor 的目的是提供一种简单且标准化的方式来收集审计日志。

架构

这个库围绕两个概念设计

  • 负责收集审计事件的审计服务
  • 负责持久化审计跟踪的存储服务

这两种服务由提供者提供。

默认提供者

该库包含一个默认提供者:DoctrineProvider

DoctrineProvider 提供审计服务和存储服务。它为所有 Doctrine ORM 数据库相关更改创建审计日志

  • 包括插入和更新及其差异和关系字段差异。
  • 多对多关系更改、关联和解关联操作。
  • 如果可用,记录负责这些更改的用户及其 IP 地址。
  • flush 事件期间插入审计条目,以保持整体状态的清洁,即使某些操作失败也是如此。

DoctrineProvider 支持以下 RDBMS

  • MySQL
  • MariaDB
  • PostgreSQL
  • SQLite

DoctrineProvider 应该与 Doctrine 支持的任何其他数据库一起工作。尽管如此,我们只能真正支持我们可以用 GitHub Actions 进行测试的数据库。

基本上,您可以通过审计日志跟踪任何实体的任何更改。

注意: DoctrineProvider 不能跟踪 DQL 或直接 SQL 语句的执行。

官方文档

auditor 的官方文档可以在 这里 找到。

版本信息

变更日志可在 这里 查看

贡献

auditor 是一个开源项目。我们欢迎社区贡献。请将您的想法、代码审查、拉取请求和功能请求发送给我们,以帮助我们改进此项目。

在向此项目贡献时,不要忘记提供单元测试。要这样做,请遵循此专用 README 中的说明

致谢

许可

auditor 可免费使用,并受 MIT 许可证 授权。