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

Add support of audit logs configurations #356

Merged
merged 8 commits into from
Nov 27, 2024

Conversation

komalsukhani
Copy link
Collaborator

@komalsukhani komalsukhani commented Nov 14, 2024

Description

Add support of Dashboard Audit logs. Add following new fields:

 auditLogs:
    # Enables audit logging.
    # It is used to set TYK_DB_AUDIT_ENABLED
    enabled: false
    # Allow users to configure how dashboard store the audit logs.
    # Possible values are db and file.
    # It is used to set TYK_DB_AUDIT_TYPE
    type: "file"
    # Format of audit log file. Possible values are json and text
    # It is used to set TYK_DB_AUDIT_FORMAT
    format: "text"
    # Path to the audit log
    # It is used to set TYK_DB_AUDIT_PATH
    path: ""
    # Enables detailed records in the audit log.
    # If set to true then audit log records will contain the http-request (without body) and full http-response including the body.
    # It is used to set TYK_DB_AUDIT_DETAILEDRECORDING
    enableDetailedRecording: false

Audit logs are disabled by default.

Related Issue

TT-13296

Motivation and Context

Test Coverage For This Change

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)
  • Documentation updates or improvements.

Checklist

  • Make sure you are requesting to pull a topic/feature/bugfix branch (right side). If PRing from your fork, don't come from your master!
  • Make sure you are making a pull request against our master branch (left side). Also, it would be best if you started your change off our latest master.
  • My change requires a change to the documentation.
    • I have manually updated the README(s)/documentation accordingly.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@buraksekili buraksekili marked this pull request as ready for review November 14, 2024 15:04
@buraksekili buraksekili requested a review from a team as a code owner November 14, 2024 15:04
@buraksekili buraksekili requested review from olamilekan000 and removed request for a team November 14, 2024 15:04
Copy link
Collaborator

@buraksekili buraksekili left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks okay to me IF audit logs will be enabled by default. If it is not enabled by default, please adjust the PR accordingly. Thanks!

@bojantyk
Copy link
Contributor

hi @komalsukhani can you pls fix the conflicts in this PR ?

@bojantyk bojantyk merged commit 414c7d5 into main Nov 27, 2024
6 of 7 checks passed
@bojantyk bojantyk deleted the TT-13296/support_auditlogs_type branch November 27, 2024 13:47
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.

3 participants