Skip to content
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.

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

Feature: Audit Log for Monitoring State Changes in Clients, Channels, Groups, and Domains #2626

Open
arvindh123 opened this issue Jan 4, 2025 · 0 comments

Comments

@arvindh123
Copy link
Contributor

Is your feature request related to a problem? Please describe.

No

Describe the feature you are requesting, as well as the possible use case(s) for it.

Audit Log Scope:

Capture create, update, delete, and any other significant state changes for the following entities:

  • Clients
  • Channels
  • Groups
  • Domains

Data to Log:

  • Unique identifier for the request (Request ID)
  • Domain in which changes happens
  • Timestamp of the change
  • Change type (create, update, delete, etc.)
  • Details of the state change (before and after values)
  • User or service initiating the change
  • Any other Additional metadata (e.g., IP address or any relevant contextual data)

Storage and Retention:

  • For Initial implementation we can use PostgreSQL and then in feature move to other storage.

Authorization

  • Only authorized user on entity should able view audit log
  • We need to add new special role action in view audit log
  • This role action will be individual entity or sub entity per entity
    **Example Action : **
  • Domains
    - view_audit
    - view_client_audit
    - view_channel_audit
    - view_group_audit
  • Groups
    - view_audit
    - view_client_audit
    - view_channel_audit
    - view_subgroup_audit
    - view_subgroup_client_audit
    - view_subgroup_channel_audit
  • Clients
    • view_audit
  • Channels
    • view_audit

API & CLI

Provide APIs or CLI tools to query audit logs based on filters like time range, entity type, change type, or user, etc..

Indicate the importance of this feature to you.

Must-have

Anything else?

No response

@arvindh123 arvindh123 self-assigned this Jan 4, 2025
@arvindh123 arvindh123 changed the title Feature: Audit Log for Monitoring State Changes in Things, Channels, Groups, and Domains Feature: Audit Log for Monitoring State Changes in Clients, Channels, Groups, and Domains Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants