audit

Documentation

Index

• Variables
• type Log
  • func NewLog(e *event.Event) (*Log, error)
• type Logger
  • func NewLogger(lf *log.Factory) Logger
• type Query
  • func (q *Query) Count(ctx context.Context, opts QueryPageOptions) (uint64, error)
  • func (q *Query) GetByIDs(ctx context.Context, ids []string) ([]*Log, error)
  • func (q *Query) QueryPage(ctx context.Context, opts QueryPageOptions, pageArgs graphqlutil.PageArgs) ([]model.PageItemRef, error)
• type QueryPageOptions
  • func (o QueryPageOptions) Apply(q db.SelectBuilder) db.SelectBuilder
• type ReadStore
  • func (s *ReadStore) Count(ctx context.Context, opts QueryPageOptions) (uint64, error)
  • func (s *ReadStore) GetByIDs(ctx context.Context, ids []string) ([]*Log, error)
  • func (s *ReadStore) QueryPage(ctx context.Context, opts QueryPageOptions, pageArgs graphqlutil.PageArgs) ([]*Log, uint64, error)
• type Sink
  • func (s *Sink) ReceiveBlockingEvent(ctx context.Context, e *event.Event) (err error)
  • func (s *Sink) ReceiveNonBlockingEvent(ctx context.Context, e *event.Event) (err error)
• type WriteStore
  • func (s *WriteStore) PersistLog(ctx context.Context, logEntry *Log) (err error)

Variables

var DependencySet = wire.NewSet(
	NewLogger,
	wire.Struct(new(Sink), "*"),
	wire.Struct(new(ReadStore), "*"),
	wire.Struct(new(WriteStore), "*"),
	wire.Struct(new(Query), "*"),
)

Types

type Log

type Log struct {
	ID           string                 `json:"id"`
	CreatedAt    time.Time              `json:"createdAt"`
	ActivityType string                 `json:"activityType"`
	UserID       string                 `json:"userID,omitempty"`
	IPAddress    string                 `json:"ipAddress,omitempty"`
	UserAgent    string                 `json:"userAgent,omitempty"`
	ClientID     string                 `json:"clientID,omitempty"`
	Data         map[string]interface{} `json:"data,omitempty"`
}

Log represents an audit log entry. The keys in JSON struct tags are in camel case because this struct is directly returned in the GraphQL endpoint. Making the keys in camel case saves us from writing boilerplate resolver code.

func NewLog

func NewLog(e *event.Event) (*Log, error)

type Logger

type Logger struct{ *log.Logger }

func NewLogger

func NewLogger(lf *log.Factory) Logger

type Query

type Query struct {
	Database *auditdb.ReadHandle
	Store    *ReadStore
}

func (*Query) Count

func (q *Query) Count(ctx context.Context, opts QueryPageOptions) (uint64, error)

func (*Query) GetByIDs

func (q *Query) GetByIDs(ctx context.Context, ids []string) ([]*Log, error)

func (*Query) QueryPage

func (q *Query) QueryPage(ctx context.Context, opts QueryPageOptions, pageArgs graphqlutil.PageArgs) ([]model.PageItemRef, error)

type QueryPageOptions

type QueryPageOptions struct {
	RangeFrom      *time.Time
	RangeTo        *time.Time
	ActivityTypes  []string
	UserIDs        []string
	EmailAddresses []string
	PhoneNumbers   []string
	SortDirection  model.SortDirection
}

func (QueryPageOptions) Apply

func (o QueryPageOptions) Apply(q db.SelectBuilder) db.SelectBuilder

type ReadStore

type ReadStore struct {
	SQLBuilder  *auditdb.SQLBuilderApp
	SQLExecutor *auditdb.ReadSQLExecutor
}

func (*ReadStore) Count

func (s *ReadStore) Count(ctx context.Context, opts QueryPageOptions) (uint64, error)

func (*ReadStore) GetByIDs

func (s *ReadStore) GetByIDs(ctx context.Context, ids []string) ([]*Log, error)

func (*ReadStore) QueryPage

func (s *ReadStore) QueryPage(ctx context.Context, opts QueryPageOptions, pageArgs graphqlutil.PageArgs) ([]*Log, uint64, error)

type Sink

type Sink struct {
	Logger   Logger
	Database *auditdb.WriteHandle
	Store    *WriteStore
}

func (*Sink) ReceiveBlockingEvent

func (s *Sink) ReceiveBlockingEvent(ctx context.Context, e *event.Event) (err error)

func (*Sink) ReceiveNonBlockingEvent

func (s *Sink) ReceiveNonBlockingEvent(ctx context.Context, e *event.Event) (err error)

type WriteStore

type WriteStore struct {
	SQLBuilder  *auditdb.SQLBuilderApp
	SQLExecutor *auditdb.WriteSQLExecutor
}

func (*WriteStore) PersistLog

func (s *WriteStore) PersistLog(ctx context.Context, logEntry *Log) (err error)