Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

feat(audit): add request/response fields to stdout audit logs (#19077)

Vincent Huang34ef93f4639d
diff --git a/backend/api/v1/audit.go b/backend/api/v1/audit.go
index 92fa85c984..8543c12b6b 100644
--- a/backend/api/v1/audit.go
+++ b/backend/api/v1/audit.go
@@ -33,6 +33,12 @@ var (
maskedString string
)
+const (
+ // maxAuditPayloadChars is the maximum characters for request/response payloads in stdout logs.
+ // Set to 100KB (102400 chars) to match AWS CloudTrail industry standard for audit logs.
+ maxAuditPayloadChars = 102400
+)
+
// AuditInterceptor is the v1 audit interceptor for gRPC server.
type AuditInterceptor struct {
store *store.Store
@@ -270,6 +276,26 @@ func logAuditToStdout(ctx context.Context, p *storepb.AuditLog) {
attrs = append(attrs, slog.String("severity", p.Severity.String()))
}
+ // Include request payload (truncated to 100KB for log manageability)
+ // Request is already redacted for sensitive data by getRequestString()
+ if p.Request != "" {
+ request := p.Request
+ if truncated, wasTruncated := common.TruncateString(p.Request, maxAuditPayloadChars); wasTruncated {
+ request = truncated + "...[truncated]"
+ }
+ attrs = append(attrs, slog.String("request", request))
+ }
+
+ // Include response payload (truncated to 100KB for log manageability)
+ // Response is already redacted for sensitive data by getResponseString()
+ if p.Response != "" {
+ response := p.Response
+ if truncated, wasTruncated := common.TruncateString(p.Response, maxAuditPayloadChars); wasTruncated {
+ response = truncated + "...[truncated]"
+ }
+ attrs = append(attrs, slog.String("response", response))
+ }
+
slog.LogAttrs(ctx, slog.LevelInfo, p.Method, attrs...)
}
diff --git a/backend/api/v1/audit_log_service_test.go b/backend/api/v1/audit_log_service_test.go
index 2e85dacf4f..30d345a991 100644
--- a/backend/api/v1/audit_log_service_test.go
+++ b/backend/api/v1/audit_log_service_test.go
@@ -7,6 +7,7 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
+ "github.com/bytebase/bytebase/backend/common"
v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
)
@@ -90,3 +91,63 @@ func TestRetentionCutoffCalculation(t *testing.T) {
})
}
}
+
+func TestLogAuditToStdout_IncludesRequestResponse(t *testing.T) {
+ // This test documents the expected behavior that request and response
+ // fields should be included in stdout audit logs when present.
+ //
+ // The actual logAuditToStdout function writes to slog, which would require
+ // setting up a custom handler to capture output. This test validates the
+ // data structure expectations.
+
+ tests := []struct {
+ name string
+ request string
+ response string
+ expectRequest bool
+ expectResponse bool
+ expectTruncated bool
+ }{
+ {
+ name: "empty request and response",
+ request: "",
+ response: "",
+ expectRequest: false,
+ expectResponse: false,
+ },
+ {
+ name: "normal request and response",
+ request: `{"name":"test"}`,
+ response: `{"success":true}`,
+ expectRequest: true,
+ expectResponse: true,
+ },
+ {
+ name: "large request should be truncated",
+ request: string(make([]byte, 150000)), // 150KB
+ response: `{"success":true}`,
+ expectRequest: true,
+ expectResponse: true,
+ expectTruncated: true,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ // Validate truncation behavior
+ if tt.expectTruncated && len(tt.request) > 102400 {
+ truncated, wasTruncated := common.TruncateString(tt.request, 102400)
+ assert.True(t, wasTruncated, "Large request should be truncated")
+ assert.LessOrEqual(t, len(truncated), 102400, "Truncated string should be within limit")
+ }
+
+ // Document that empty strings should not be logged
+ if tt.request == "" {
+ assert.False(t, tt.expectRequest, "Empty request should not be logged")
+ }
+ if tt.response == "" {
+ assert.False(t, tt.expectResponse, "Empty response should not be logged")
+ }
+ })
+ }
+}