Skip to content

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

@arvindh123

Description

@arvindh123

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

Metadata

Metadata

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions