Package cloud.opencode.base.log.audit

package cloud.opencode.base.log.audit
Audit Logging - Compliance and Security Event Recording 审计日志 - 合规和安全事件记录

This package provides audit logging capabilities for recording user actions, security events, and data changes for compliance and analysis.

本包提供审计日志功能，用于记录用户操作、安全事件和数据更改， 以满足合规性和分析需求。

Key Classes | 核心类

Simple Audit Logging | 简单审计日志

// Basic logging
AuditLog.log("user123", "LOGIN", "system", "SUCCESS");

// Login/Logout events
AuditLog.logLogin("user123", true, "192.168.1.1");
AuditLog.logLogout("user123");

// Data change events
AuditLog.logDataChange("admin", "User", "user456", "UPDATE", oldUser, newUser);

Builder Pattern | 构建器模式

AuditLog.event("UPDATE_USER")
    .userId("admin")
    .target("User")
    .targetId("user456")
    .success()
    .ip("192.168.1.1")
    .detail("field", "email")
    .detail("oldValue", "old@example.com")
    .detail("newValue", "new@example.com")
    .build();  // Automatically logged

Custom Audit Logger | 自定义审计记录器

// Implement custom logger (e.g., database storage)
public class DatabaseAuditLogger implements AuditLogger {
    @Override
    public void log(AuditEvent event) {
        auditRepository.save(event);
    }
}

// Register custom logger
AuditLog.setLogger(new DatabaseAuditLogger());

Audit Event Fields | 审计事件字段

  • eventId - Unique event identifier
  • timestamp - Event timestamp
  • userId - User who performed the action
  • action - Action type (LOGIN, UPDATE, DELETE, etc.)
  • target - Target entity type
  • targetId - Target entity ID
  • result - SUCCESS or FAILURE
  • ip - Client IP address
  • userAgent - Client user agent
  • details - Additional key-value details
Since:
JDK 25, opencode-base-log V1.0.0
Author:
OpenCode Cloud Group
See Also:
  • Class
    Description
    AuditEvent
    Audit Event - Immutable Audit Log Entry 审计事件 - 不可变的审计日志条目
    AuditEvent.Builder
    Builder for AuditEvent.
    AuditLog
    AuditLog - Audit Logging Utility AuditLog - 审计日志工具
    AuditLog.LoggingBuilder
    Builder that automatically logs when build() is called.
    AuditLogger
    Audit Logger Interface - Audit Event Recording 审计记录器接口 - 审计事件记录