audit

Documentation

Index

• Variables
• func WithActor(ctx context.Context, actor string) context.Context
• func WithMetadata(ctx context.Context, md map[string]interface{}) (context.Context, error)
• type AuditOption
  • func WithActorExtractor(fn func(context.Context) (string, error)) AuditOption
  • func WithMetadataExtractor(fn func(context.Context) map[string]interface{}) AuditOption
  • func WithRepository(r repository) AuditOption
• type Log
• type Service
  • func New(opts ...AuditOption) *Service
  • func (s *Service) Log(ctx context.Context, action string, data interface{}) error

Variables

var (
	TimeNow = time.Now

	ErrInvalidMetadata = errors.New("failed to cast existing metadata to map[string]interface{} type")
)

Functions

func WithActor

func WithActor(ctx context.Context, actor string) context.Context

func WithMetadata

func WithMetadata(ctx context.Context, md map[string]interface{}) (context.Context, error)

Types

type AuditOption

type AuditOption func(*Service)

func WithActorExtractor

func WithActorExtractor(fn func(context.Context) (string, error)) AuditOption

func WithMetadataExtractor

func WithMetadataExtractor(fn func(context.Context) map[string]interface{}) AuditOption

func WithRepository

func WithRepository(r repository) AuditOption

type Log

type Log struct {
	Timestamp time.Time   `json:"timestamp"`
	Action    string      `json:"action"`
	Actor     string      `json:"actor"`
	Data      interface{} `json:"data"`
	Metadata  interface{} `json:"metadata"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...AuditOption) *Service

func (*Service) Log

func (s *Service) Log(ctx context.Context, action string, data interface{}) error