userAuditLogEntries は、ユーザーアカウントの監査ログです。ログイン、パスワードとメールアドレスの変更、リンクされたアカウント、管理者による操作を記録します。1 つのドキュメントは 1 つのアカウントに対する 1 件のイベントです。web が管理しており、スキーマは 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 | 何が起きたか。login のような kebab-case の名前です(下の表を参照)。 | 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) | エントリを 1 件作成します。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 がそれを複合インデックスに置き換えます。スキーマは userId と managedSubscriptionId に index: true を付けていますが、Mongoose の自動インデックス作成は無効なため(services/web/app/src/infrastructure/Mongoose.mjs:7)、インデックスを作成するのは上記のマイグレーションだけです。managedSubscriptionId のインデックスのマイグレーションには saas タグしか付いていません。
補足
- エントリは TTL インデックスにより、
timestampから 2.5 年後に期限切れになります。

