Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

audit

package module

Go to main page

Versions in this module

v1

v1.9.0

Sep 14, 2026

v1.8.0

Sep 12, 2026

v1.7.0

Aug 26, 2026

v1.5.1

Aug 26, 2026

v1.5.0

Aug 21, 2026

v1.4.1

Aug 21, 2026

Changes in this version

type Config

+ OnEnqueueFailed func(record *Record)

+ OnWriteFailed func(record *Record, err error)

v1.4.0

Aug 12, 2026

v1.3.0

Mar 6, 2026

v1.2.0

Mar 6, 2026

v1.1.0

Feb 3, 2026

Changes in this version

+ const MaxRecordJSONSize

type Record

+ func (r *Record) Copy() *Record

v1.0.0

Jan 25, 2026

Changes in this version

+ func MaskDestination(dest string, channel string) string

+ func MaskEmail(email string) string

+ func MaskIP(ip string) string

+ func MaskPhone(phone string) string

+ func MaskString(s string, keepChars int) string

+ type Config struct

+ Enabled bool

+ MaskDestination bool

+ TTL time.Duration

+ Writer *WriterConfig

+ func DefaultConfig() *Config

+ type DatabaseConfig struct

+ TableName string

+ func DefaultDatabaseConfig() *DatabaseConfig

+ type DatabaseStorage struct

+ func NewDatabaseStorage(databaseURL string) (*DatabaseStorage, error)

+ func NewDatabaseStorageFromDB(db *sql.DB, dbType string, config *DatabaseConfig) (*DatabaseStorage, error)

+ func NewDatabaseStorageWithConfig(databaseURL string, config *DatabaseConfig) (*DatabaseStorage, error)

+ func (s *DatabaseStorage) Close() error

+ func (s *DatabaseStorage) DB() *sql.DB

+ func (s *DatabaseStorage) DBType() string

+ func (s *DatabaseStorage) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (s *DatabaseStorage) Write(ctx context.Context, record *Record) error

+ type EventType string

+ const EventAccessDenied

+ const EventAccessGranted

+ const EventChallengeCreated

+ const EventChallengeExpired

+ const EventChallengeRevoked

+ const EventChallengeVerified

+ const EventCustom

+ const EventLoginFailed

+ const EventLoginSuccess

+ const EventLogout

+ const EventRateLimited

+ const EventSendFailed

+ const EventSendSuccess

+ const EventSessionCreate

+ const EventSessionExpire

+ const EventUserCreated

+ const EventUserDeleted

+ const EventUserLocked

+ const EventUserUnlocked

+ const EventUserUpdated

+ const EventVerificationFailed

+ const EventVerificationSuccess

+ type FileStorage struct

+ func NewFileStorage(filePath string) (*FileStorage, error)

+ func (s *FileStorage) Close() error

+ func (s *FileStorage) FilePath() string

+ func (s *FileStorage) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (s *FileStorage) Rotate() error

+ func (s *FileStorage) Write(ctx context.Context, record *Record) error

+ type Logger struct

+ func NewLogger(storage Storage, config *Config) *Logger

+ func NewLoggerWithWriter(storage Storage, config *Config) *Logger

+ func (l *Logger) GetStats() *Stats

+ func (l *Logger) Log(ctx context.Context, record *Record)

+ func (l *Logger) LogAccess(ctx context.Context, eventType EventType, userID, resource string, ...)

+ func (l *Logger) LogAuth(ctx context.Context, eventType EventType, userID string, result Result, ...)

+ func (l *Logger) LogChallenge(ctx context.Context, eventType EventType, challengeID, userID string, ...)

+ func (l *Logger) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (l *Logger) SetLogCallback(fn func(record *Record))

+ func (l *Logger) Stop() error

+ type MultiStorage struct

+ func NewMultiStorage(storages ...Storage) *MultiStorage

+ func (m *MultiStorage) Close() error

+ func (m *MultiStorage) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (m *MultiStorage) Storages() []Storage

+ func (m *MultiStorage) Write(ctx context.Context, record *Record) error

+ type NoopStorage struct

+ func NewNoopStorage() *NoopStorage

+ func (s *NoopStorage) Close() error

+ func (s *NoopStorage) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (s *NoopStorage) Write(ctx context.Context, record *Record) error

+ type QueryFilter struct

+ ChallengeID string

+ Channel string

+ EndTime int64

+ EventType string

+ IP string

+ Limit int

+ Offset int

+ Result string

+ SessionID string

+ StartTime int64

+ UserID string

+ func DefaultQueryFilter() *QueryFilter

+ func (f *QueryFilter) Normalize()

+ func (f *QueryFilter) WithChallengeID(challengeID string) *QueryFilter

+ func (f *QueryFilter) WithChannel(channel string) *QueryFilter

+ func (f *QueryFilter) WithEventType(eventType string) *QueryFilter

+ func (f *QueryFilter) WithIP(ip string) *QueryFilter

+ func (f *QueryFilter) WithLimit(limit int) *QueryFilter

+ func (f *QueryFilter) WithOffset(offset int) *QueryFilter

+ func (f *QueryFilter) WithResult(result string) *QueryFilter

+ func (f *QueryFilter) WithSessionID(sessionID string) *QueryFilter

+ func (f *QueryFilter) WithTimeRange(startTime, endTime int64) *QueryFilter

+ func (f *QueryFilter) WithUserID(userID string) *QueryFilter

+ type Record struct

+ ChallengeID string

+ Channel string

+ Destination string

+ DurationMS int64

+ EventID string

+ EventType EventType

+ IP string

+ Metadata map[string]interface{}

+ Provider string

+ ProviderMessageID string

+ Purpose string

+ Reason string

+ RequestID string

+ Resource string

+ Result Result

+ SessionID string

+ Timestamp int64

+ TraceID string

+ UserAgent string

+ UserID string

+ func NewRecord(eventType EventType, result Result) *Record

+ func RecordFromJSON(data []byte) (*Record, error)

+ func (r *Record) SetTimestamp(ts int64) *Record

+ func (r *Record) ToJSON() ([]byte, error)

+ func (r *Record) WithChallengeID(challengeID string) *Record

+ func (r *Record) WithChannel(channel string) *Record

+ func (r *Record) WithDestination(destination string) *Record

+ func (r *Record) WithDuration(durationMS int64) *Record

+ func (r *Record) WithIP(ip string) *Record

+ func (r *Record) WithMetadata(key string, value interface{}) *Record

+ func (r *Record) WithProvider(provider, messageID string) *Record

+ func (r *Record) WithPurpose(purpose string) *Record

+ func (r *Record) WithReason(reason string) *Record

+ func (r *Record) WithRequestID(requestID string) *Record

+ func (r *Record) WithResource(resource string) *Record

+ func (r *Record) WithSessionID(sessionID string) *Record

+ func (r *Record) WithTraceID(traceID string) *Record

+ func (r *Record) WithUserAgent(ua string) *Record

+ func (r *Record) WithUserID(userID string) *Record

+ type RecordOption func(*Record)

+ func WithRecordChannel(channel string) RecordOption

+ func WithRecordDestination(dest string) RecordOption

+ func WithRecordIP(ip string) RecordOption

+ func WithRecordMetadata(key string, value interface{}) RecordOption

+ func WithRecordProvider(provider, messageID string) RecordOption

+ func WithRecordPurpose(purpose string) RecordOption

+ func WithRecordReason(reason string) RecordOption

+ func WithRecordRequestID(requestID string) RecordOption

+ func WithRecordTraceID(traceID string) RecordOption

+ func WithRecordUserAgent(ua string) RecordOption

+ type RedisConfig struct

+ KeyPrefix string

+ TTL time.Duration

+ func DefaultRedisConfig() *RedisConfig

+ type RedisStorage struct

+ func NewRedisStorage(client *redis.Client) *RedisStorage

+ func NewRedisStorageWithConfig(client *redis.Client, config *RedisConfig) *RedisStorage

+ func (s *RedisStorage) Cleanup(ctx context.Context) (int64, error)

+ func (s *RedisStorage) Client() *redis.Client

+ func (s *RedisStorage) Close() error

+ func (s *RedisStorage) KeyPrefix() string

+ func (s *RedisStorage) Query(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ func (s *RedisStorage) TTL() time.Duration

+ func (s *RedisStorage) Write(ctx context.Context, record *Record) error

+ type Result string

+ const ResultFailure

+ const ResultPending

+ const ResultSuccess

+ type Stats struct

+ QueueCap int

+ QueueLength int

+ Started bool

+ Stopped bool

+ Workers int

+ type Storage interface

+ Close func() error

+ Query func(ctx context.Context, filter *QueryFilter) ([]*Record, error)

+ Write func(ctx context.Context, record *Record) error

+ func NewStorageFromType(storageType StorageType, opts *StorageOptions) (Storage, error)

+ type StorageOptions struct

+ DatabaseURL string

+ FilePath string

+ RedisClient *redis.Client

+ RedisPrefix string

+ RedisTTL time.Duration

+ TableName string

+ type StorageType string

+ const StorageTypeDB

+ const StorageTypeDatabase

+ const StorageTypeFile

+ const StorageTypeNone

+ const StorageTypeRedis

+ func ParseStorageType(s string) StorageType

+ type Writer struct

+ func NewWriter(storage Storage, config *WriterConfig) *Writer

+ func (w *Writer) Enqueue(record *Record) bool

+ func (w *Writer) GetStats() Stats

+ func (w *Writer) OnEnqueueFailed(fn func(record *Record)) *Writer

+ func (w *Writer) OnWriteFailed(fn func(record *Record, err error)) *Writer

+ func (w *Writer) Start()

+ func (w *Writer) Stop() error

+ type WriterConfig struct

+ QueueSize int

+ StopTimeout time.Duration

+ Workers int

+ func DefaultWriterConfig() *WriterConfig