Audit Logging

Ensure every critical action is logged (vital for UAG/Trust Room).

majiayu000 dd598ee 2 files · 1.9 KB Updated 567 repo stars

File contents

Audit Logging Protocol

1. Principles

  • No Invisible Actions: Every state-changing API call (POST, PUT, DELETE) must produce a log entry.
  • Traceability: Logs must include userId, action, resourceId, and metadata.

2. Implementation Standards

  • Backend (API):
    • Use the project's standard Logger service (e.g., src/services/logger.ts or similar).
    • Example:
      await Logger.info({
        event: 'POST_CREATED',
        userId: user.id,
        metadata: { postId: newPost.id },
      });
      
  • Database (Supabase):
    • Ensure tables have created_at, updated_at, and created_by columns.
    • Check if specific Audit Table inserts are required (e.g. audit_logs table).

3. Verification Checklist

  • Does the new API endpoint call Logger?
  • Are logs visible in Supabase/Dashboards?
  • Is the log level appropriate (Info vs Error)?
  • Does the log contain enough context to debug issues later?

majiayu000/claude-skill-registry-data/tree/main/data/audit-logging-cityfish91159-maihouses commit dd598ee5bd

Frequently asked questions

npx skillmds add majiayu000/audit-logging-2