Skip to content

API Reference

The DD logging library provides a rich API surface, organized by functional module below.

Core Components

ModuleDescriptionDocs
Package FunctionsGlobal log functions, convenience constructorsPackage Functions
LoggerCore logger and its methodsLogger
LoggerEntryLog Entry with preset fieldsLoggerEntry
ConfigConfiguration struct and presetsConfig
InterfacesCoreLogger, LogProvider, and other interfacesInterfaces

Output & Writers

ModuleDescriptionDocs
WritersFileWriter, BufferedWriter, MultiWriterOutput Targets
ContextContext integration and ContextExtractorContext Integration

Extension Features

ModuleDescriptionDocs
FieldsStructured field constructors (20 kinds)Structured Fields
HooksLifecycle hook systemHook System
SecuritySensitive-data filtering and security configSecurity Filtering
AuditAudit logging and audit eventsAudit Logging
IntegrityLog integrity signing and verificationIntegrity Signing

Auxiliary Tools

ModuleDescriptionDocs
Debug VisualPrint/JSON/Text/Exit debug functionsDebug Output
RecorderTest-helper log recorderTest Helper
ConstantsLog levels, formats, error codesConstants & Errors

Quick Locator

go
// Basic usage
dd.Info("message")                        // -> Package Functions
dd.InfoWith("msg", dd.String("k", "v"))   // -> Package Functions + Fields

// Create a custom logger
logger, _ := dd.New(dd.DefaultConfig())    // -> Package Functions + Config
logger.WithFields(fields).Info("msg")      // -> Logger + Entry

// File output
fw, _ := dd.NewFileWriter("logs/app.log", dd.DefaultFileWriterConfig())  // -> Writers

// Security
sec := dd.DefaultSecurityConfig()          // -> Security
audit, _ := dd.NewAuditLogger(dd.DefaultAuditConfig())  // -> Audit

Next Steps