Skip to content

chore: Go over logs & introduce audit logs#218

Merged
alexluong merged 6 commits into
mainfrom
log
Feb 6, 2025
Merged

chore: Go over logs & introduce audit logs#218
alexluong merged 6 commits into
mainfrom
log

Conversation

@alexluong

@alexluong alexluong commented Jan 23, 2025

Copy link
Copy Markdown
Collaborator

Here are all the audit logs we have in this PR:

  • event ingestion (processing new event, enqueue event to deliverymq)
  • event delivery (status, whether a retry is scheduled or canceled)
  • alert

You can look for them using logger.Audit as a search term too.


Questions:

1: One question I have is whether we should include the caller field in the log JSON. Caller is the file and line number that the log is called from.

@vercel

vercel Bot commented Jan 23, 2025

Copy link
Copy Markdown

@alexluong is attempting to deploy a commit to the Hookdeck team on Vercel, but is not a member of this team. To resolve this issue, you can:

  • Make your repository public. Collaboration is free for open source and public repositories.
  • Add @alexluong as a member. A Pro subscription is required to access Vercel's collaborative features.
    • If you're the owner of the team, click here and add @alexluong as a member.
    • If you're the user who initiated this build request, click here to request access.
    • If you're already a member of the Hookdeck team, make sure that your Vercel account is connected to your GitHub account.

To read more about collaboration on Vercel, click here.

@alexbouchardd

Copy link
Copy Markdown
Contributor

We'll need audit logs for tenants CRUD & destinations CRUD

@alexluong

Copy link
Copy Markdown
Collaborator Author

We'll need audit logs for tenants CRUD & destinations CRUD

I think it's probably better to use the logger in EntityStore for this case instead of the API handlers, right?

@alexbouchardd

Copy link
Copy Markdown
Contributor

Sure ultimately I just think the audit traces need to represent those actions

@alexluong

Copy link
Copy Markdown
Collaborator Author

@alexbouchardd for updates, do you think it's important to capture the data change, or would logging the updated destination JSON a good enough solution?

For actions like "disable destination", is it better to log the specific "disable", or can we treat it as "update destination"?

Base automatically changed from audit-log to main February 6, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants