Documentation
¶
Index ¶
- type FileLogger
- type JSONLog
- type JSONLogEntry
- type JSONLogger
- type Logger
- func (l *Logger) DeleteLogs(target string) error
- func (l *Logger) EnableFileLogging(e bool)
- func (l *Logger) EnableJSONLogging(e bool)
- func (l *Logger) GetJSONLogs(target string) (*JSONLog, error)
- func (l *Logger) InitJSON()
- func (l *Logger) InitLogFile(path string) error
- func (l *Logger) SetLoggingState(target, state string)
- func (l *Logger) WriteLogEntry(target, task, entry, err string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileLogger ¶
type FileLogger struct {
// contains filtered or unexported fields
}
FileLogger allows parlay to log output to a file on the local filesystem
type JSONLog ¶
type JSONLog struct {
State string `json:"state"`
Entries []JSONLogEntry `json:"entries"`
}
JSONLog contains all of the output from a parlay execution
type JSONLogEntry ¶
type JSONLogEntry struct {
Created time.Time `json:"created"`
TaskName string `json:"task"`
Err string `json:"error"`
Entry string `json:"entry"`
}
JSONLogEntry contains the details a specific action
type JSONLogger ¶
type JSONLogger struct {
// contains filtered or unexported fields
}
JSONLogger allows parlay to log output to an in-memory jsonStruct
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger - is a stuct that manages the verious types of logger available
func (*Logger) DeleteLogs ¶
DeleteLogs - will remove logs for a particular target
func (*Logger) EnableFileLogging ¶
EnableFileLogging - will enable logging to a file
func (*Logger) EnableJSONLogging ¶
EnableJSONLogging - will enable logging through JSON
func (*Logger) GetJSONLogs ¶
GetJSONLogs - returns a pointer to the current JSON Logs
func (*Logger) InitJSON ¶
func (l *Logger) InitJSON()
InitJSON - will start/initialise the JSON logging functionality
func (*Logger) InitLogFile ¶
InitLogFile - will initialise file based logging
func (*Logger) SetLoggingState ¶
SetLoggingState - currently a NOOP (TODO)
func (*Logger) WriteLogEntry ¶
WriteLogEntry will capture what is transpiring and where
Source Files