Skip to content

Microservice pattern: Audit logging #2692

Open

Description

@iluwatar

Description:

The Audit Logging design pattern is crucial for microservices architectures, providing a means to record significant events and changes within the system. This pattern helps in maintaining a comprehensive trail of activities, which is vital for debugging, security audits, and compliance purposes.

Key elements of the Audit Logging design pattern include:

  1. Centralized Logging Service: A dedicated service responsible for receiving and storing logs from various microservices.
  2. Log Formatter: Standardized format for logs to ensure consistency and readability.
  3. Security and Compliance: Ensure logs are stored securely and comply with regulatory requirements.
  4. Log Filtering and Aggregation: Ability to filter and aggregate logs to extract meaningful insights.
  5. Scalability: The logging service should handle a high volume of logs efficiently.
  6. Performance: Logging should not adversely impact the performance of microservices.

References:

Acceptance Criteria:

  1. Implement a centralized logging service that can receive logs from various microservices.
  2. Ensure logs are formatted consistently using a standard log formatter.
  3. Implement security measures to protect log data and ensure compliance with relevant regulations.
  4. Develop mechanisms for log filtering and aggregation to facilitate meaningful analysis.
  5. Validate that the logging service can scale and handle high volumes of log data efficiently.
  6. Ensure the logging mechanism has minimal impact on the performance of the microservices.

Activity

  1. converted this from a draft issue on Oct 15, 2023
  2. mgerogianniscsdauth commented on Oct 30, 2023

    @mgerogianniscsdauth

    @iluwatar If it's alright with you, may I be assigned to work on this issue? Thank you in advance!

  3. moved this from Todo to In Progress in Java Design Patterns projecton Nov 25, 2023
  4. stale commented on Jan 24, 2024

    @stale

    This issue has been automatically marked as stale because it has not had recent activity. The issue will be unassigned if no further activity occurs. Thank you for your contributions.

  5. added
    status: staleissues and pull requests that have not had recent interaction
    on Jan 24, 2024
  6. removed
    status: staleissues and pull requests that have not had recent interaction
    on Mar 24, 2024
  7. removed
    status: staleissues and pull requests that have not had recent interaction
    on Mar 24, 2024
  8. moved this from In Progress to Todo in Java Design Patterns projecton Mar 24, 2024
  9. AbhinandanSonvane commented on Nov 24, 2024

    @AbhinandanSonvane

    Hi @iluwatar , After going through the acceptance criteria of this issue, the implementation involves building services similar to

    1. Splunk Forwarder
    2. Splunk Indexer
    3. Splunk Searchead

    All these services must be horizontally scalable.

    Kindly clarify before we discuss the low-level design aspects of the issue.

  10. athikha commented on Oct 17, 2025

    @athikha

    Hi @iluwatar, can you assign this to me?

  11. moved this from Todo to In Progress in Java Design Patterns projecton Jun 1, 2026
  12. priyanshuvishwakarma273403 commented on Jul 12, 2026

    @priyanshuvishwakarma273403
    Contributor

    "Hi, I'd like to work on this issue. Could you assign it to me?"

  13. github-actions commented on Oct 16, 2026

    @github-actions

    This issue is stale because it has been open 60 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions