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

activitylog

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 23, 2026

Changes in this version

+ const DefaultPageSize

+ const MaxPageSize

+ var ErrInvalid = errors.New("activitylog: invalid input")

+ func WithActor(ctx context.Context, actor Ref) context.Context

type Activity

+ Actor Ref

type Entry

+ Actor Ref

type Options

+ ActorFrom func(ctx context.Context) (Ref, bool)

+ BatchFrom func(ctx context.Context) (string, bool)

+ LoggingDisabled func(ctx context.Context) bool

+ PropertiesFrom func(ctx context.Context) (map[string]any, bool)

+ TenantFrom func(ctx context.Context) (string, bool)

+ type Page struct

+ Activities []Activity

+ Next int64

type Query

+ Actor Ref

type Ref

+ func ActorFrom(ctx context.Context) (Ref, bool)

+ func (r Ref) String() string

v0.1.0

Oct 23, 2026

Changes in this version

+ const DefaultLimit

+ const DefaultLogName

+ const EventCreated

+ const EventDeleted

+ const EventUpdated

+ const MaxLimit

+ var ErrEmptyEntry = errors.New("activitylog: entry needs an event or a description")

+ var ErrInvalidActivity = errors.New("activitylog: invalid activity")

+ var ErrInvalidDiff = errors.New("activitylog: invalid diff")

+ var ErrInvalidQuery = errors.New("activitylog: invalid query")

+ var ErrNilStore = errors.New("activitylog: store is nil")

+ var ErrNoSubject = errors.New("activitylog: cannot determine the subject")

+ func BatchFrom(ctx context.Context) string

+ func LoggingDisabled(ctx context.Context) bool

+ func PropertiesFrom(ctx context.Context) map[string]any

+ func TenantFrom(ctx context.Context) string

+ func WithBatch(ctx context.Context) context.Context

+ func WithCauser(ctx context.Context, causer Ref) context.Context

+ func WithProperties(ctx context.Context, props map[string]any) context.Context

+ func WithTenant(ctx context.Context, tenantID string) context.Context

+ func WithoutLogging(ctx context.Context) context.Context

+ type Activity struct

+ BatchID string

+ Causer Ref

+ Changes Changes

+ CreatedAt time.Time

+ Description string

+ Event string

+ ID int64

+ LogName string

+ Properties json.RawMessage

+ Subject Ref

+ TenantID string

+ func (a Activity) Clone() Activity

+ func (a Activity) Validate() error

+ type Change struct

+ New json.RawMessage

+ Old json.RawMessage

+ Redacted bool

+ type Changes map[string]Change

+ func Diff(before, after any) (Changes, error)

+ func (c Changes) Clone() Changes

+ type Entry struct

+ Causer Ref

+ Changes Changes

+ Description string

+ Event string

+ LogName string

+ Properties map[string]any

+ Subject Ref

+ TenantID string

+ type Logger struct

+ func New(store Store, opts Options) (*Logger, error)

+ func (l *Logger) Created(ctx context.Context, e Entry, model any) error

+ func (l *Logger) Deleted(ctx context.Context, e Entry, model any) error

+ func (l *Logger) Log(ctx context.Context, e Entry) error

+ func (l *Logger) LogChange(ctx context.Context, e Entry, before, after any) error

+ func (l *Logger) Updated(ctx context.Context, e Entry, before, after any) error

+ type Options struct

+ Enrich func(ctx context.Context, a *Activity)

+ LogEmptyUpdates bool

+ LogName string

+ Now func() time.Time

+ type Pruner interface

+ Prune func(ctx context.Context, before time.Time) (int64, error)

+ type Query struct

+ BatchID string

+ BeforeID int64

+ Causer Ref

+ Event string

+ Limit int

+ LogName string

+ Since time.Time

+ Subject Ref

+ TenantID string

+ Until time.Time

+ func (q Query) Matches(a Activity) bool

+ func (q Query) Normalize() (Query, error)

+ type Reader interface

+ List func(ctx context.Context, q Query) ([]Activity, error)

+ type Ref struct

+ ID string

+ Type string

+ func CauserFrom(ctx context.Context) Ref

+ func (r Ref) IsZero() bool

+ type Store interface

+ Insert func(ctx context.Context, a Activity) error

+ type Subject interface

+ ActivityRef func() Ref