feat: audit logs

[bl0up]

Summary by CodeRabbit

• New Features
  • Introduced a new documentation file on audit logs, detailing their functionalities and benefits within the platform.
  • Added user guidance for accessing audit logs and refining searches using four specific filters: Timestamp, Service, User, and Action.

[linear]

CUS-360 new system audit logs

[coderabbitai]

Walkthrough

A new document, 23_audit_logs.md, has been added to the SettleMint Blockchain Transformation Platform, providing an in-depth overview of audit logs. It highlights their importance in compliance and data integrity and guides users on accessing and filtering logs for efficient monitoring and management of application activities.

Changes

Files	Change Summary
docs/using-platform/23_audit_logs.md	Introduces a detailed overview of audit logs, their functionalities, and access methods. Includes visual aids and descriptions of four filters for log searches.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Application
    participant AuditLogService

    User->>Application: Access audit logs
    Application->>AuditLogService: Request log data
    AuditLogService-->>Application: Return log entries
    Application-->>User: Display logs with filters

Loading

🐰 In the meadow, logs will dance,
With filters to give us a chance!
Compliance and integrity shine bright,
Helping us manage, day and night.
Hooray for logs, our trusty friend,
In the blockchain world, they'll never end! 🌟

---

Note

Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.