logger

Documentation

Overview

Package logger is a general-use logger utility for loftsman

Index

• func GetHelpLogo() string
• type Logger
  • func New(jsonLogFile *os.File, commandName string) *Logger
  • func (log *Logger) ClosingHeader(text string)
  • func (log *Logger) GetRecord() string
  • func (log *Logger) Header(text string)
  • func (log *Logger) SubHeader(text string)

Functions

func GetHelpLogo

func GetHelpLogo() string

GetHelpLogo will return the logo to display in the CLI help

Types

type Logger

type Logger struct {
	zerolog.Logger
}

Logger is our main logger object

func New

func New(jsonLogFile *os.File, commandName string) *Logger

New will return a new instance of a logger

func (*Logger) ClosingHeader

func (log *Logger) ClosingHeader(text string)

ClosingHeader will precede closing/final/called-out log lines

func (*Logger) GetRecord

func (log *Logger) GetRecord() string

GetRecord will return the saved log record from any single cli run

func (*Logger) Header

func (log *Logger) Header(text string)

Header will log a header for a section of other log messages

func (*Logger) SubHeader

func (log *Logger) SubHeader(text string)

SubHeader will print a subheader section in log output