log

Overview ¶

Package log provides secure telemetry logging with strict security controls.

SECURITY MODEL:

This package implements strict security controls for telemetry logging to prevent PII and sensitive information from being sent to external telemetry services.

REQUIREMENTS:

• Messages MUST be constant templates only - no dynamic parameter replacement
• Stack traces MUST be redacted to show only Datadog, runtime, and known 3rd party frames
• Errors MUST use SafeError type with message redaction
• slog.Any() only allowed with LogValuer implementations

BENEFITS:

• Constant messages enable deduplication to reduce redundant log transmission

SECURE USAGE PATTERNS:

// ✅ Correct - constant message with structured data
telemetrylog.Error("operation failed", slog.String("operation", "startup"))
telemetrylog.Error("validation error", slog.Any("error", SafeError(err)))
telemetrylog.Error("operation failed", slog.Any("error", SafeError(err)), WithStacktrace())

// ❌ Forbidden - dynamic messages
telemetrylog.Error(err.Error()) // Raw error message
telemetrylog.Error("failed: " + details) // String concatenation
telemetrylog.Error(fmt.Sprintf("error: %s", err)) // Format strings

// ❌ Forbidden - raw error exposure
telemetrylog.Error("failed", slog.Any("error", err)) // Raw error object
telemetrylog.Error("failed", slog.String("err", err.Error())) // Raw error message