auditor

README

go-auditor

Library to record user event trails to any database or console.

This is work in progress

The development on this library just started.

Features

• [x]

Installation

$ go get -u github.com/openbooking/go-auditor

Quick Start

package main

}

Documentation

Overview

auditor Package provides a logging facility for user actions

Index

• type Auditor
• type Event
• type LogEntry
• type Trail

Types

type Auditor

type Auditor interface {
	NewTrail(ctx context.Context, namespace, actor, clientIP string, group string) Trail
	FetchLog(group string, maxRows int) ([]LogEntry, error)
}

type Event

type Event struct {
	TargetID string
	Action   string
	Message  string
}

type LogEntry

type LogEntry struct {
	Event
	ID        int
	Namespace string
	Actor     string
	Timestamp time.Time
}

type Trail

type Trail interface {
	Log(event Event)
	LogIfChanged(event Event, oldval, newval interface{})
	LogIfBoolChanged(event Event, oldval, newval bool, trueMsg, falseMsg string)
	Success()
	Failed()
}