Skip to content

chore(doc): add audit log event naming convention #2090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 27, 2024
Merged

chore(doc): add audit log event naming convention #2090

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b3f108
chore(doc): add audit log event naming convention
kim-tsao Aug 26, 2024
4d309c2
Update plugins/audit-log-node/README.md
kim-tsao Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions plugins/audit-log-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ The `DefaultAuditLogger.createAuditLogDetails` will generate the `actorId` of th
- The actor id generated from the `express.Request` object provided in the arguments
- `null` if neither of the above fields were provided in the arguments

#### Event Naming Convention

It is recommended that you prefix the `eventName` value with the name of the component you are audit logging. This will help with searchability in the central log collector.

For example, "ScaffolderTaskRead", "CatalogEntityFetch", etc.

---

**IMPORTANT**
Expand Down