Skip to content

Commit d752577

Browse files
kim-tsaoZaperex
andauthored
chore(doc): add audit log event naming convention (#2090)
* chore(doc): add audit log event naming convention Signed-off-by: Kim Tsao <[email protected]> * Update plugins/audit-log-node/README.md Co-authored-by: Frank Kong <[email protected]> --------- Signed-off-by: Kim Tsao <[email protected]> Co-authored-by: Frank Kong <[email protected]>
1 parent 9eaaa8d commit d752577

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

plugins/audit-log-node/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ The `DefaultAuditLogger.createAuditLogDetails` will generate the `actorId` of th
2424
- The actor id generated from the `express.Request` object provided in the arguments
2525
- `null` if neither of the above fields were provided in the arguments
2626

27+
#### Event Naming Convention
28+
29+
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.
30+
31+
For example, "ScaffolderTaskRead", "CatalogEntityFetch", etc.
32+
2733
---
2834

2935
**IMPORTANT**

0 commit comments

Comments
 (0)