userAuditLogEntries 是用户账户的审计日志:登录、密码和邮箱变更、关联账户以及管理员操作。一个文档是一个账户上的一个事件。由 web 负责;schema 为 services/web/app/src/models/UserAuditLogEntry.mjs,核心代码通过 services/web/app/src/Features/User/UserAuditLogHandler.mjs 写入。
字段
| 字段 | 类型 | 含义 | 来源 |
|---|---|---|---|
_id | ObjectId | 条目 id。 | UserAuditLogEntry.mjs:4 |
userId | ObjectId | 事件涉及的账户。 | UserAuditLogEntry.mjs:6 |
operation | String | 发生了什么,为 kebab-case 名称,例如 login(见下表)。 | UserAuditLogEntry.mjs:11 |
initiatorId | ObjectId | 操作者:用户本人,或管理员操作时的管理员。少数操作可能缺失,例如 reset-password(UserAuditLogHandler.mjs:19-33)。 | UserAuditLogEntry.mjs:9 |
ipAddress | String | 请求的 IP 地址(req.ip)。少数操作可能缺失(UserAuditLogHandler.mjs:8-17)。 | UserAuditLogEntry.mjs:10 |
info | Object | 事件详情;键取决于操作。 | UserAuditLogEntry.mjs:8 |
timestamp | Date | 条目写入的时间(默认 Date.now)。 | UserAuditLogEntry.mjs:12 |
managedSubscriptionId | ObjectId | 用户的托管群组订阅。仅在启用 saas 功能时设置(UserAuditLogHandler.mjs:92-107),因此在 CE 中从不出现。 | UserAuditLogEntry.mjs:7 |
__v | Number | Mongoose 版本键,由 UserAuditLogEntry.create 添加。 | UserAuditLogHandler.mjs:109 |
谁写入
| 代码 | 作用 |
|---|---|
UserAuditLogHandler.mjs:62-110 (addEntry) | 创建一个条目。缺少 operation,或某个操作需要的 ipAddress 或 initiatorId 缺失时抛出错误。 |
UserAuditLogHandler.mjs:112-126 (addEntryInBackground) | 同上,但不等待;错误只记录到日志。 |
services/web/modules/admin-tools/app/src/AdminAuditLog.mjs:14-38 | 我们的管理面板:logOnUser 把管理员操作写到目标账户上,并以管理员为操作者;当目标已没有日志时(已彻底清除的用户、模板),logOnAdmin 写到管理员自己的账户上。 |
services/web/modules/authentication/auditLog.mjs:9-21 | 我们的 LDAP、SAML 和 OIDC 模块:logLoginEntry 记录一次 SSO 登录对账户做了什么,并以该账户本身为操作者。 |
services/web/app/src/Features/User/UserDeleter.mjs:141 | 已删除用户过期时,删除该用户的所有条目(expireDeletedUsersAfterDuration)。 |
AdminAuditLog.mjs:41-43 (deleteUserEntries) | 我们的管理面板在彻底清除用户时删除其所有条目(services/web/modules/admin-tools/app/src/AdminUserManager.mjs:644)。 |
tools/migrations/20220913125500_migrate_auditLog_to_collections.mjs | 一次性迁移:把旧的 users.auditLog 数组移到此集合。 |
operation | 写入位置 (services/web/app/src/...) |
|---|---|
login | Features/Authentication/AuthenticationController.mjs:225 |
failed-password-match | Features/Authentication/AuthenticationManager.mjs:150 |
logout | Features/User/UserController.mjs:599 |
update-password | Features/User/UserController.mjs:131 |
clear-sessions | Features/User/UserController.mjs:167 |
reset-password | Features/PasswordReset/PasswordResetHandler.mjs:106 |
delete-account | Features/User/UserDeleter.mjs:50 |
account-suspension | Features/User/UserUpdater.mjs:621 |
must-reset-password-unset | Features/User/UserUpdater.mjs:604 |
add-email, remove-email, change-primary-email | Features/User/UserUpdater.mjs:99, :494, :247 |
migrate-default-email | Features/User/UserUpdater.mjs:355 |
clear-institution-sso-data, clear-third-party-identifiers | Features/User/UserUpdater.mjs:160, :196 |
confirm-email | Features/User/UserEmailsController.mjs:750 |
request-add-email-code, add-email-via-code, confirm-email-via-code | Features/User/UserEmailsController.mjs:138, :331, :354 |
resend-add-email-code, resend-confirm-email-code | Features/User/UserEmailsController.mjs:391 (名称见 :417, :423) |
link-sso, unlink-sso | Features/User/ThirdPartyIdentityManager.mjs:64, :131 (由我们的 OIDC 模块使用) |
link-institution-sso, unlink-institution-sso, migrate-institution-sso-id, unlink-institution-sso-not-migrated | Features/User/SAMLIdentityManager.mjs:103, :293, :424, :462 |
accept-group-invitation, join-group-subscription, leave-group-subscription, remove-from-group-subscription | Features/Subscription/TeamInvitesController.mjs:276, Features/Subscription/SubscriptionUpdater.mjs:104, :133, :193, Features/Subscription/SubscriptionGroupController.mjs:127 |
ai-quota-breach | infrastructure/rate-limiters/AiFeatureUsageRateLimiter.mjs:35, infrastructure/rate-limiters/TokenUsageRateLimiter.mjs:99, :191 |
services/web/modules/...):
operation | 写入位置 |
|---|---|
create-account | authentication/ldap/app/src/LDAPAuthenticationManager.mjs:58, authentication/saml/app/src/SAMLAuthenticationManager.mjs:56, authentication/oidc/app/src/OIDCAuthenticationManager.mjs:75, admin-tools/app/src/AdminUserManager.mjs:167 |
remove-password | authentication/ldap/app/src/LDAPAuthenticationManager.mjs:78, authentication/saml/app/src/SAMLAuthenticationManager.mjs:94 |
link-institution-sso | authentication/saml/app/src/SAMLAuthenticationManager.mjs:71 |
change-admin-access, change-name | authentication/auditLog.mjs:37, :47 (SSO 登录); admin-tools/app/src/AdminUserManager.mjs:394, :391 (管理员) |
failed-password-match | authentication/auditLog.mjs:80 (LDAP) |
logout | authentication/auditLog.mjs:58 |
send-activation-email, send-password-reset-email | admin-tools/app/src/AdminUserManager.mjs:184, :207 |
update-password, change-features, change-ai-features, account-reactivation | admin-tools/app/src/AdminUserManager.mjs:389, :397, :400, :403 |
clear-sessions, transfer-projects, restore-account, reset-ai-usage | admin-tools/app/src/AdminUserManager.mjs:514, :563, :694, :712 |
purge-deleted-user, purge-deleted-project, delete-template (写在管理员的账户上) | admin-tools/app/src/AdminUserManager.mjs:645, admin-tools/app/src/AdminProjectManager.mjs:525, admin-tools/app/src/AdminTemplateManager.mjs:67 |
publish-template, edit-template, delete-template | template-gallery/app/src/TemplateGalleryController.mjs:52, :107, :137 |
link-dropbox, unlink-dropbox | dropbox/app/src/DropboxController.mjs:87, :107, dropbox/index.mjs:38 |
link-github, unlink-github | github-sync/app/src/GitHubSyncController.mjs:155, :175 |
integration-account-linked, integration-account-unlinked | GitLab 和 Gitea 同步 (gitlab-sync/app/src/GitLabSyncController.mjs:155, :181, gitea-sync/app/src/GiteaSyncController.mjs:155, :181), Zotero 和 Mendeley (tpr-webmodule/app/src/ZoteroController.mjs:77, :99, tpr-webmodule/app/src/MendeleyController.mjs:77, :99) |
create-git-token, delete-git-token | oauth2-server/app/src/OAuthPersonalAccessTokenController.mjs:48, :74 |
谁读取
| 代码 | 作用 |
|---|---|
services/web/modules/admin-tools/app/src/AdminAuditLog.mjs:124-126 (listUserEntries) | 我们管理面板的审计日志标签页,GET /admin/user/:userId/audit-log/list(services/web/modules/admin-tools/app/src/AdminToolsRouter.mjs:32-36)。 |
索引
| 名称 | 键 | 选项 | 迁移 |
|---|---|---|---|
timestamp_1 | { timestamp: 1 } | TTL, expireAfterSeconds: 78840000 (2.5 年) | tools/migrations/20220913105500_create_auditLog_indexes.mjs |
userId_1_timestamp_-1 | { userId: 1, timestamp: -1 } | tools/migrations/20251117093546_add_timestamp_to_userAuditLogEntries.mjs |
tools/migrations/20220929193200_add_auditLog_indexes.mjs 最初在 { userId: 1 } 上创建了 user_id_1;20251117093546 用复合索引替换了它。schema 用 index: true 标记了 userId 和 managedSubscriptionId,但 Mongoose 自动索引已关闭(services/web/app/src/infrastructure/Mongoose.mjs:7),因此只有上述迁移会创建索引。managedSubscriptionId 的索引迁移只带 saas 标签。
说明
- 条目通过 TTL 索引在
timestamp之后 2.5 年过期。

