ToolJet 審計(jì)日志Audit Logs完整指南記錄、篩選、脫敏與文件導(dǎo)出【免費(fèi)下載鏈接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 項(xiàng)目地址: https://gitcode.com/GitHub_Trending/to/ToolJet本文圍繞 ToolJet 的審計(jì)日志Audit Logs功能展開系統(tǒng)講解如何通過日期范圍與多維度篩選檢索賬戶內(nèi)全部操作記錄、如何解讀每條日志的完整字段結(jié)構(gòu)以及如何通過環(huán)境變量配置日志文件的生成路徑、每日輪轉(zhuǎn)與敏感信息脫敏。讀完本文你將能夠在自托管部署中開啟審計(jì)日志文件輸出并結(jié)合 環(huán)境變量配置 與 syslog 集成方案 落地合規(guī)審計(jì)與安全追蹤。付費(fèi)功能提示Audit Logs 屬于 ToolJet 的付費(fèi)功能Paid feature需要對(duì)應(yīng)的許可證支持。什么是審計(jì)日志審計(jì)日志是 ToolJet 賬戶內(nèi)所有操作行為的自動(dòng)記錄報(bào)告。它自動(dòng)捕獲并展示事件記錄誰who在何時(shí)when、何地where執(zhí)行了什么操作what同時(shí)附帶 IP 地址等信息。簡單來說每一次登錄、建應(yīng)用、跑查詢、改權(quán)限等動(dòng)作都會(huì)被記錄成一條可檢索、可追溯的事件。在服務(wù)端每條審計(jì)事件對(duì)應(yīng)一張數(shù)據(jù)庫表記錄其實(shí)體定義位于 server/src/entities/audit_log.entity.ts對(duì)應(yīng)數(shù)據(jù)庫表audit_logs。核心字段包括idUUID 主鍵唯一事件 IDuser_id/organization_id執(zhí)行者用戶與所屬組織resource_id/resource_name/resource_type被操作資源的 ID、名稱與類型resource_type使用枚舉取值見 server/src/modules/app/constants/modules.ts包含APP、USER、DataQueries、GroupPermissions等action_type動(dòng)作類型如APP_CREATE、USER_LOGINip_address來源 IPmetadataJSON 結(jié)構(gòu)包含tooljet_version與user_agentcreated_at事件產(chǎn)生時(shí)間。日志寫入側(cè)還使用了 winston 自定義格式auditLog見 server/src/modules/audit-logs/constants/index.ts把審計(jì)數(shù)據(jù)注入auditLog字段并提取resourceType作為日志label這解釋了下方示例日志文件中的結(jié)構(gòu)。在界面中查看與檢索日志打開賬戶的 Audit Logs 頁面即可看到日志列表視圖默認(rèn)展示最近 24 小時(shí)的日志并提供日期范圍選擇、篩選與分頁能力。日期范圍Date Range使用范圍選擇器range picker檢索指定日期與時(shí)間區(qū)間內(nèi)發(fā)生的事件默認(rèn)加載最近 24 小時(shí)的日志作為初始視圖from 與 to 之間可指定的最大跨度是 30 天超出范圍無法檢索頁面底部提供分頁導(dǎo)航每頁最多展示 7 條日志。30 天最大查詢跨度由許可證條款控制。前端通過getMaxDurationForAuditLogs()請(qǐng)求/license/audit-logs/max-duration接口獲取上限見 frontend/src/_services/auditLogsService.js服務(wù)端對(duì)應(yīng)控制器定義在 server/src/modules/licensing/controllers/audit-logs.controller.ts其能力受許可證字段MAX_DURATION_FOR_AUDIT_LOGSmaxDaysForAuditLogs約束見 server/src/modules/licensing/constants/index.ts。篩選審計(jì)日志Audit Logs 頁面提供四組篩選條件可組合使用以快速定位目標(biāo)事件。按用戶篩選Select Users從下拉列表中選擇特定用戶即可查看該用戶的所有活動(dòng)記錄。按應(yīng)用篩選Select Apps下拉列表會(huì)展示當(dāng)前賬戶關(guān)聯(lián)的全部應(yīng)用。選擇某個(gè)應(yīng)用后日志將只保留與該應(yīng)用相關(guān)的記錄。按資源篩選Select Resources資源Resources說明User過濾全部用戶類事件如USER_LOGIN、USER_SIGNUP、USER_INVITE、USER_INVITE_REDEEM。App過濾全部應(yīng)用類事件如APP_CREATE、APP_UPDATE、APP_VIEW、APP_DELETE、APP_IMPORT、APP_EXPORT、APP_CLONE。Data Query過濾與數(shù)據(jù)查詢關(guān)聯(lián)的事件如DATA_QUERY_RUN。Group Permission過濾全部與用戶組權(quán)限關(guān)聯(lián)的事件包括GROUP_CREATE、GROUP_UPDATE、GROUP_DELETE。App Group Permission每個(gè)用戶組內(nèi)可為應(yīng)用設(shè)置只讀或可編輯權(quán)限這些變更會(huì)作為應(yīng)用組權(quán)限事件被記錄。前端獲取資源列表調(diào)用getResources()請(qǐng)求/audit-logs/resources接口見 frontend/src/_services/auditLogsService.js。需要說明的是資源枚舉在代碼層面是可擴(kuò)展的除上表外server/src/modules/app/constants/modules.ts 中還定義了Workflows、AppGit、AppHistory、DataQueryFolders等更多模塊類型界面中是否展示取決于當(dāng)前版本與許可證能力。按動(dòng)作篩選Select Actions動(dòng)作Actions說明USER_LOGIN每次用戶登錄時(shí)記錄。USER_SIGNUP每次新用戶注冊(cè)時(shí)記錄。USER_INVITE在Manage Users中邀請(qǐng)用戶時(shí)每次發(fā)送邀請(qǐng)都會(huì)記錄一條事件。USER_INVITE_REDEEM邀請(qǐng)被兌換接受時(shí)記錄。APP_CREATE用戶創(chuàng)建新應(yīng)用時(shí)記錄。APP_UPDATE對(duì)應(yīng)用重命名、設(shè)為公開、編輯分享鏈接或部署應(yīng)用等操作時(shí)記錄。APP_VIEW有人查看已發(fā)布應(yīng)用時(shí)記錄公開應(yīng)用不計(jì)入。APP_DELETE用戶從儀表盤刪除應(yīng)用時(shí)記錄。APP_IMPORT用戶導(dǎo)入應(yīng)用時(shí)記錄。APP_EXPORT應(yīng)用被導(dǎo)出時(shí)記錄。APP_CLONE復(fù)制現(xiàn)有應(yīng)用生成克隆時(shí)記錄。DATA_QUERY_RUN添加數(shù)據(jù)源、創(chuàng)建查詢或從查詢編輯器/已發(fā)布應(yīng)用中運(yùn)行查詢時(shí)記錄。GROUP_PERMISSION_CREATE創(chuàng)建用戶組時(shí)記錄。GROUP_PERMISSION_UPDATE向組中添加/移除應(yīng)用或用戶或更新組權(quán)限時(shí)記錄。GROUP_PERMISSION_DELETE從賬戶中刪除用戶組時(shí)記錄。APP_GROUP_PERMISSION_UPDATE為用戶組中的應(yīng)用設(shè)置View查看或Edit編輯權(quán)限且權(quán)限被更新時(shí)記錄默認(rèn)情況下應(yīng)用對(duì)用戶組的權(quán)限為View。理解日志信息展開任一條日志可以看到完整的結(jié)構(gòu)化信息。下面對(duì)照 readinglogv2 截圖 逐字段解讀。屬性Property說明action_type該事件記錄的動(dòng)作類型具體取值見上文 按動(dòng)作篩選 一節(jié)。created_at事件被記錄時(shí)的日期與時(shí)間。id每條事件被分配的唯一事件 ID。ip_address產(chǎn)生該事件來源的 IP 地址。metadata包含兩個(gè)子屬性tooljet_version事件發(fā)生時(shí) ToolJet 的版本與user_agent使用的設(shè)備與瀏覽器信息。organization_idToolJet 中每個(gè)組織都有唯一 ID事件發(fā)生時(shí)會(huì)被一并記錄。resource_id不同 資源 在創(chuàng)建時(shí)被分配各自關(guān)聯(lián)的 ID。resource_name參與事件記錄的 資源 名稱例如創(chuàng)建或刪除應(yīng)用時(shí)會(huì)顯示該應(yīng)用的名稱。resource_type指示參與事件的 資源 類型。user_id每個(gè)用戶賬戶在 ToolJet 中有唯一 ID事件發(fā)生時(shí)一并記錄。這些字段與數(shù)據(jù)庫實(shí)體一一對(duì)應(yīng)見 server/src/entities/audit_log.entity.ts其中resource_type是枚舉列取值源自MODULES常量server/src/modules/app/constants/modules.tsmetadata以 JSON 存儲(chǔ)。日志文件導(dǎo)出、輪轉(zhuǎn)、脫敏與路徑除界面內(nèi)查看外審計(jì)日志還可以輸出為本地文件便于歸檔、投遞到 syslog 或第三方分析平臺(tái)。日志文件Log File日志文件會(huì)包含審計(jì)日志的全部數(shù)據(jù)。只要在環(huán)境變量中指定了路徑系統(tǒng)就會(huì)在該路徑下生成日志文件并且每生成一條新審計(jì)日志文件都會(huì)被動(dòng)態(tài)更新。關(guān)于如何啟用日志文件生成可參考 syslog 集成指南只需將環(huán)境變量LOG_FILE_PATH設(shè)為期望的路徑例如rsyslog即可激活該功能。詳細(xì)的啟動(dòng)與驗(yàn)證步驟包括如何檢查生成的目錄結(jié)構(gòu)都在該文檔中。日志輪轉(zhuǎn)Log Rotation日志文件按每日輪轉(zhuǎn)每天都會(huì)創(chuàng)建一個(gè)新日志文件從而高效地管理與組織審計(jì)數(shù)據(jù)。實(shí)現(xiàn)上服務(wù)端基于winston-daily-rotate-file的DailyRotateFiletransport 完成輪轉(zhuǎn)目錄名為{process_id}-%DATE%文件名固定為audit.log日期模式為YYYY-MM-DD輪轉(zhuǎn)時(shí)還會(huì)把舊文件的內(nèi)容整理并寫出為.json格式的歸檔文件相關(guān)代碼見 server/src/modules/log-to-file/constants/index.ts。日志脫敏Log RedactionToolJet 實(shí)現(xiàn)了日志脫敏以保護(hù)敏感信息。默認(rèn)情況下以下請(qǐng)求/響應(yīng)頭在日志中被掩碼authorizationcookieset-cookiex-api-keyproxy-authorizationwww-authenticateauthentication-infox-forwarded-for在服務(wù)端這些默認(rèn)脫敏路徑被硬編碼在 pino logger 的redact.paths配置中并統(tǒng)一使用[REDACTED]作為掩碼內(nèi)容同時(shí)會(huì)把環(huán)境變量LOGGER_REDACT中的逗號(hào)分隔字段合并進(jìn)脫敏路徑列表見 server/src/modules/app/loader.ts。此外你還可以通過LOGGER_REDACT環(huán)境變量指定自定義脫敏字段變量說明LOGGER_REDACT需要被掩碼的額外字段的逗號(hào)分隔列表例如req.headers[x-session-id],req.headers[x-device-fingerprint]例如LOGGER_REDACTres.headers[x-rate-limit-remaining],res.headers[x-request-id]注意LOGGER_REDACT中的每個(gè)條目會(huì)被直接拼接到 pino 的redact.paths數(shù)組server/src/modules/app/loader.ts因此請(qǐng)使用與示例一致的 pino 路徑語法如req.headers[xxx]、res.headers[xxx]。日志文件路徑Log File Path日志文件的路徑由環(huán)境變量LOG_FILE_PATH定義。該路徑相對(duì)于機(jī)器的主目錄home directory。例如若LOG_FILE_PATH設(shè)為hsbc/dashboard/log則最終生成的日志文件路徑結(jié)構(gòu)如下homepath/hsbc/dashboard/log/tooljet_log/{process_id}-{date}/audit.log其中{process_id}是唯一進(jìn)程標(biāo)識(shí)符的占位符{date}表示當(dāng)前日期。這種結(jié)構(gòu)化路徑確保審計(jì)日志按進(jìn)程與日期雙重組織便于追蹤與分析。變量說明LOG_FILE_PATH日志文件將被創(chuàng)建的路徑例如tooljet/log/tooljet-audit.log該行為與代碼實(shí)現(xiàn)一致服務(wù)端使用path.join(os.homedir(), filePath, tooljet_log)計(jì)算絕對(duì)目錄目錄不存在時(shí)會(huì)自動(dòng)遞歸創(chuàng)建再以{processId}-%DATE%作為子目錄寫入audit.log見 server/src/modules/log-to-file/constants/index.ts。示例日志文件數(shù)據(jù)以下是一條APP_CREATE事件的真實(shí)日志結(jié)構(gòu)展開查看{ level: info, message: PERFORM APP_CREATE OF awdasdawdwd APP, timestamp: 2023-11-02 17:12:40, auditLog: { userId: 0ad48e21-e7a2-4597-9568-c4535aedf687, organizationId: cf8e132f-a68a-4c81-a0d4-3617b79e7b17, resourceId: eac02f79-b8e2-495a-bffe-82633416c829, resourceType: APP, actionType: APP_CREATE, resourceName: awdasdawdwd, ipAddress: ::1, metadata: { userAgent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36, tooljetVersion: 2.22.2-ee2.8.3 } }, label: APP }可以看到auditLog內(nèi)的字段與界面展示的日志屬性一一對(duì)應(yīng)且與數(shù)據(jù)庫實(shí)體字段保持一致頂層timestamp使用YYYY-MM-DD HH:mm:ss格式label取自resourceType二者均由 winston 日志格式在寫入時(shí)注入見 server/src/modules/log-to-file/constants/index.ts 與 server/src/modules/audit-logs/constants/index.ts。數(shù)據(jù)保留策略審計(jì)日志在數(shù)據(jù)庫中會(huì)按保留期自動(dòng)清理。服務(wù)端通過AuditLogsClearScheduler定時(shí)任務(wù)server/src/modules/audit-logs/scheduler.ts實(shí)現(xiàn)任務(wù)每天凌晨 2:00CronExpression.EVERY_DAY_AT_2AM運(yùn)行刪除早于保留期截止日期的日志截止日期 當(dāng)前日期 - 保留天數(shù)保留天數(shù)由環(huán)境變量AUDIT_LOGS_RETENTION_PERIOD控制默認(rèn) 90 天將該變量設(shè)為0可跳過清理永久保留審計(jì)日志。# 默認(rèn)保留 90 天不設(shè)置時(shí) # 自定義保留天數(shù)例如 30 天 AUDIT_LOGS_RETENTION_PERIOD30 # 禁用自動(dòng)清理永久保留 AUDIT_LOGS_RETENTION_PERIOD0權(quán)限與可用性說明審計(jì)日志受許可證license控制屬于付費(fèi)能力服務(wù)端通過FeatureAbilityGuard結(jié)合許可證字段LICENSE_FIELD.AUDIT_LOGSauditLogsEnabled進(jìn)行能力校驗(yàn)前端在無權(quán)限時(shí)僅渲染空頁面見 frontend/src/modules/auditLogs/pages/AuditLogsPage/AuditLogsPage.jsx后端提供/audit-logs、/audit-logs/resources、/license/audit-logs/license-terms、/license/audit-logs/max-duration等接口見 frontend/src/_services/auditLogsService.js 與 server/src/modules/licensing/controllers/audit-logs.controller.ts在 server/src/modules/licensing/constants/index.ts 的計(jì)劃定義中Audit logs 屬于 Teambusiness及以上計(jì)劃的功能。最佳實(shí)踐小結(jié)按需設(shè)置保留期默認(rèn) 90 天的清理策略適合大多數(shù)場(chǎng)景若有合規(guī)留存要求可通過AUDIT_LOGS_RETENTION_PERIOD0關(guān)閉清理或設(shè)置更長天數(shù)。開啟日志文件輸出設(shè)置LOG_FILE_PATH相對(duì)主目錄即可生成每日輪轉(zhuǎn)的audit.log輪轉(zhuǎn)時(shí)自動(dòng)產(chǎn)出 JSON 歸檔方便投遞 syslog 或?qū)敕治銎脚_(tái)。主動(dòng)脫敏敏感頭默認(rèn)脫敏列表覆蓋authorization、cookie、x-api-key等常見敏感頭自定義頭如會(huì)話 ID、設(shè)備指紋務(wù)必通過LOGGER_REDACT補(bǔ)充掩碼避免敏感信息進(jìn)入日志。善用篩選組合結(jié)合「用戶 應(yīng)用 資源 動(dòng)作」四維篩選與 30 天范圍查詢可快速定位安全事件如異常的USER_LOGIN、越權(quán)的APP_GROUP_PERMISSION_UPDATE。留意許可證邊界審計(jì)日志是付費(fèi)功能查詢最大時(shí)間跨度也受許可證maxDaysForAuditLogs約束自托管部署前請(qǐng)確認(rèn)許可證與版本支持情況。【免費(fèi)下載鏈接】ToolJetOpen-source foundation of ToolJet AI - the enterprise app generation platform for internal tools, dashboards, business applications, workflows and AI agents. Build visually, from a prompt, or from Claude Code, Codex and Cursor over MCP 項(xiàng)目地址: https://gitcode.com/GitHub_Trending/to/ToolJet創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考