log

Documentation

Index

• Constants
• func Error(err error)
• func FHLogger() *log.Logger
• func Fail(err *fail.Fail, who string)
• func NewEntry(Type string, entry string)
• func SyslogError(err error)
• type Iter
• type Log
  • func Get(iter *Iter) ([]*Log, error)

Constants

const (
	// DS is the location of the log dS file
	DS = "core" + string(os.PathSeparator) + "log.ds"
	// AuthType is the log type for authentication log entries
	AuthType = "authentication"
	// Four04Type is the log type for 404 errors
	Four04Type = "404"
)

Functions

func Error

func Error(err error)

Error logs and error to the core log datastore. For core code the rule for error logging is to not log it until it's "bubbled up to the top". Meaning only the http handler should log the error. This is to prevent the same error from being logged a bunch of times.

func FHLogger

func FHLogger() *log.Logger

FHLogger returns a logger for use with the http server

func Fail

func Fail(err *fail.Fail, who string)

Fail logs a failure in the datastore

func NewEntry

func NewEntry(Type string, entry string)

NewEntry inserts a new log entry into the datastore

func SyslogError

func SyslogError(err error)

SyslogError logs the error to the system log, UNIX only

Types

type Iter

type Iter struct {
	Type  string           `json:"type,omitempty"`
	From  *json.RawMessage `json:"from,omitempty"`
	To    *json.RawMessage `json:"to,omitempty"`
	Skip  int              `json:"skip,omitempty"`
	Limit int              `json:"limit,omitempty"`
	Order string           `json:"order,omitempty"`
}

Iter is an iterator for log entries

type Log

type Log struct {
	When string `json:"when"`
	Type string `json:"type"`
	Log  string `json:"log"`
}

Log is the storage stucture for a log entry

func Get

func Get(iter *Iter) ([]*Log, error)

Get retrieves a list of logs from the datastore