hlog

hlog package

This package is only used for golang beginners' practice. I cannot guarantee its quality.
This package provides a brief logging module.

How to use

After importing, use hlog.Init() to specify where the log file store and some relative information. defer hlog.Finalize() ensure all logs will be recorded.

//init log.
hlog.Init("./logFileDir/", "logFileNamePrefix", "logInFilePrefix", hlog.AutoScreenFile)
defer hlog.Finalize()

To add a new log, use hlog.Info(), hlog.Error() and more. For instance:

hlog.Info("Listening on " + CONN_HOST + ":" + CONN_PORT + "\n")   // here~
l, err := net.Listen(CONN_TYPE, ":"+CONN_PORT)
if err != nil {
  hlog.Panic("Error listening: %s", err.Error())                  // and here!
}                                                                 // Note that hlog.Panic() will throw a panic while hlog.Error() will not.
defer l.Close()

Initialization

Use hlog.Init(logFileDir, logFileNamePrefix, logInFilePrefix string, args ...interface{}) to initialize.
You must specify logFileDir, logFileNamePrefix and logInFilePrefix before starting log.

• logFileDir is the path where the log file is stored. It can be with or without a suffix /. If you provide a invalid path, it will use "./.logfile/" as default path.
• logFileNamePrefix is the file name prefix of your log, which is in the logFileDir directory.
• logInFilePrefix is the prefix of each of your logs.

Suppose you used hlog.Init("./.myLogDir", "myFile.r", "myLog") and added some log using hlog.Info(), you will have a file named ./.myLogDir/myFile.r, in where contains some log like:

myLog [INF] 2021-07-23 09:00:00.00 -> source_file.go:21 (pc=a9644b): your commits...
myLog [EMP] 2021-07-23 09:01:00.00 -> source_file.go:893 (pc=a869a5): your commits...
myLog [INF] 2021-07-23 09:02:00.00 -> source_file.go:47 (pc=a96ecd): your commits...
myLog [INF] 2021-07-23 09:03:00.00 -> source_file.go:49 (pc=d2644b): your commits...
myLog [INF] 2021-07-23 09:04:00.00 -> source_file.go:53 (pc=10c5bb3): your commits...
myLog [INF] 2021-07-23 09:05:00.00 -> source_file.go:78 (pc=10d0853): your commits...
myLog [WAN] 2021-07-23 09:06:00.00 -> source_file.go:976 (pc=506989): your commits...

Some optional parameters are available. For instance, you can decide where the log output goes. Use AutoScreenFile, AutoScreen, AllStdOutScreenFile, AllStdOutScreen or OnlyFile in hlog.Init().

• AutoScreenFile log at stdout and stderr (depends on the log category) and write to file.
• AutoScreen log at stdout and stderr (depends on the log category) but not write to file.
• AllStdOutScreenFile log at stdout (whatever the log category) and write to file.
• AllStdOutScreen log at stdout (whatever the log category) but not write to file.
• OnlyFile write to file but not print at screen (higher logging speed).

You can also use an int variable to specify calldepth in runtime.Caller().
Split file into small pieces to avoid large single file is support. To limit the number of logs in a single file, append Slice(num) as the optional parameter in Init(), where num is an uint indicating how many logs a single file has.

Add logs

It's easy to add logs. Using Emphasize(), Info(), Debug(), Warn(), Error(), Panic() and Fatal(). Note that Panic() will throw a panic, and Fatal() will end the process.

Colorful Terminal

This package also provides some free functions that enable you print colorful text in your POSIX-like terminal using printf-style. Now support printing default color, green, red and blue text on stdout and stderr (and I think it is sufficient for most uses).
To print, use PrintDefault(), PrintGreen(), PrintRed() and PrintBlue() like using a fmt.Printf(). Add a suffix E to print on stderr.
StartGreen(), StartRed() and StartBlue() will change the color of text printing after the function call. Use EndColor() to restore default color of text.