> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Project Audit Log Entries 集合

`projectAuditLogEntries` 是專案的稽核記錄：共用、邀請、擁有權轉移、下載以及管理員操作。一份文件是一個專案上的一個事件。由 `web` 負責；結構描述為 `services/web/app/src/models/ProjectAuditLogEntry.mjs`，核心程式碼透過 `services/web/app/src/Features/Project/ProjectAuditLogHandler.mjs` 寫入。

#### 欄位

| 欄位 | 型別 | 意義 | 來源 |
| - | - | - | - |
| `_id` | ObjectId | 項目 id。 | `ProjectAuditLogEntry.mjs:4` |
| `projectId` | ObjectId | 事件所涉及的專案。 | `ProjectAuditLogEntry.mjs:6` |
| `operation` | String | 發生了什麼，為 kebab-case 名稱，例如 `send-invite`（見下表）。 | `ProjectAuditLogEntry.mjs:8` |
| `initiatorId` | ObjectId | 執行操作的使用者，或管理員操作時的管理員。 | `ProjectAuditLogEntry.mjs:9` |
| `ipAddress` | String | 請求的 IP 位址（`req.ip`）。 | `ProjectAuditLogEntry.mjs:10` |
| `timestamp` | Date | 項目寫入的時間（預設 `Date.now`）。 | `ProjectAuditLogEntry.mjs:11` |
| `info` | Object | 事件詳細資料；鍵取決於操作。 | `ProjectAuditLogEntry.mjs:12` |
| `managedSubscriptionId` | ObjectId | 相關使用者的受管理群組訂閱。僅在啟用 `saas` 功能時才找得到（`services/web/app/src/Features/Subscription/SubscriptionLocator.mjs:111-112`），因此在 CE 中從不出現。 | `ProjectAuditLogEntry.mjs:7` |
| `__v` | Number | Mongoose 版本鍵，由 `ProjectAuditLogEntry.create` 加入。 | `ProjectAuditLogHandler.mjs:103` |

#### 誰寫入

| 程式碼 | 作用 |
| - | - |
| `ProjectAuditLogHandler.mjs:80-105` (`addEntry`), `:157-171` (`addEntryInBackground`) | 建立一個項目（每個相關的受管理訂閱一個，這只會在 `saas` 下發生）。 |
| `ProjectAuditLogHandler.mjs:120-150` (`addEntryIfManaged`), `:175-190` | 只在涉及受管理訂閱時寫入。在 CE 中該查詢一律傳回空值，因此這些呼叫不會寫入任何項目。 |
| `services/web/modules/admin-tools/app/src/AdminAuditLog.mjs:24-32` (`logOnProject`) | 我們的管理面板以管理員為執行者寫入管理員操作。 |
| `services/web/app/src/Features/Project/ProjectDeleter.mjs:392` | 已刪除專案過期時，刪除該專案的所有項目（`expireDeletedProject`，`ProjectDeleter.mjs:344`）。 |
| `tools/migrations/20220913125500_migrate_auditLog_to_collections.mjs` | 一次性遷移：將舊的 `projects.auditLog` 陣列移到此集合。 |

核心程式碼透過 `addEntry` 或 `addEntryInBackground` 寫入的操作：

| `operation` | 寫入位置 (`services/web/app/src/Features/...`) |
| - | - |
| `send-invite`, `revoke-invite`, `resend-invite`, `accept-invite` | `Collaborators/CollaboratorsInviteController.mjs:198`, `:237`, `:293`, `:538` |
| `sharing-link-created`, `sharing-link-updated` | `Collaborators/CollaboratorsInviteController.mjs:698`, `:713` |
| `editor-moved-to-pending` | `Collaborators/CollaboratorsInviteHandler.mjs:183` |
| `remove-collaborator`, `leave-project` | `Collaborators/CollaboratorsController.mjs:67`, `:98` |
| `project-role-changed` | `Collaborators/CollaboratorsHandler.mjs:396` |
| `transfer-ownership` | `Collaborators/OwnershipTransferHandler.mjs:122` |
| `toggle-access-level` | `Project/ProjectController.mjs:268` |
| `accept-via-link-sharing` | `TokenAccess/TokenAccessController.mjs:366`, `:594` |
| `join-via-token`, `readonly-via-sharing-updates` | `TokenAccess/TokenAccessController.mjs:477`, `:660` |
| `project-downloaded` | `Downloads/ProjectDownloadsController.mjs:220`, `:276` |
| `project-exported-<type>` (例如 `project-exported-docx`) | `Downloads/ProjectDownloadsController.mjs:153-158` |

我們的模組寫入的操作（`services/web/modules/...`）：

| `operation` | 寫入位置 |
| - | - |
| `integration-repo-linked`, `integration-repo-unlinked` | `github-sync/app/src/GitHubSyncController.mjs:94`, `:201`, `:244`; `gitlab-sync/app/src/GitLabSyncController.mjs:94`, `:213`, `:256`; `gitea-sync/app/src/GiteaSyncController.mjs:94`, `:213`, `:256` |
| `publish-template` | `template-gallery/app/src/TemplateGalleryController.mjs:53` |
| `restore-deleted-doc`, `project-deleted`, `project-restored` | `admin-tools/app/src/AdminProjectManager.mjs:477`, `:492`, `:513`; `admin-tools/app/src/AdminUserManager.mjs:688` (`project-restored`) |

核心程式碼也會為 `project-created`、`project-deleted`、`project-archived`、`project-unarchived`、`project-trashed`、`project-untrashed`、`project-restored`、`project-cloned`（`Project/ProjectController.mjs:292-479`）以及 `project-history-version-restored`、`project-history-version-downloaded`（`History/HistoryController.mjs:334`、`:396`、`:454`、`:711`）呼叫 `addEntryIfManaged`。這些在 CE 中不會寫入任何內容；CE 資料庫中的 `project-deleted` 和 `project-restored` 項目來自管理面板。

#### 誰讀取

| 程式碼 | 作用 |
| - | - |
| `services/web/modules/admin-tools/app/src/AdminAuditLog.mjs:128-130` (`listProjectEntries`) | 我們管理面板的專案稽核記錄，`GET /admin/project/:projectId/audit-log/list`（`services/web/modules/admin-tools/app/src/AdminToolsRouter.mjs:120-124`）。 |

CE 核心沒有顯示此記錄的頁面。

#### 索引

| 名稱 | 鍵 | 選項 | 遷移 |
| - | - | - | - |
| `timestamp_1` | `{ timestamp: 1 }` | TTL, `expireAfterSeconds: 78840000` (2.5 年) | `tools/migrations/20220913105500_create_auditLog_indexes.mjs` |
| `projectId_1_timestamp_-1` | `{ projectId: 1, timestamp: -1 }` | | `tools/migrations/20250912102601_add_timestamp_to_projectAuditLogEntries_index.mjs` |

`tools/migrations/20220929193200_add_auditLog_indexes.mjs` 最初在 `{ projectId: 1 }` 上建立了 `project_id_1`；`20250912102601` 以複合索引取代它。由於 Mongoose 自動建立索引已關閉（`services/web/app/src/infrastructure/Mongoose.mjs:7`），結構描述中的 `index: true` 標記不會生效。`managedSubscriptionId` 的索引遷移只帶有 `saas` 標籤。

#### 說明

* 項目透過 TTL 索引在 `timestamp` 之後 2.5 年過期；專案的已刪除記錄過期時，該專案的所有項目也會一併刪除。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.