README
¶
logHandler
logHandler centralises application logging and log file rotation.
It exposes a set of preconfigured *log.Logger instances (Info, Warning, Error, Timing, Audit, etc.) which write to stdout/stderr and to rotating log files (via lumberjack).
How it works
- Initialises automatically via
init()when the package is imported. - Log file location is derived from the application paths and the configured application name.
- Most log categories can be enabled/disabled via
commonConfig. - Uses ANSI colour prefixes on non-Windows platforms.
Common loggers
A few of the exported loggers:
logHandler.InfoLoggerlogHandler.WarningLoggerlogHandler.ErrorLoggerlogHandler.PanicLoggerlogHandler.TimingLoggerlogHandler.AuditLoggerlogHandler.DatabaseLoggerlogHandler.CacheLogger
(There are more categories in logHandler.go.)
Usage
package main
import (
"github.com/mt1976/frantic-core/logHandler"
)
func main() {
logHandler.InfoLogger.Println("hello")
logHandler.WarningLogger.Println("something to look at")
logHandler.ErrorLogger.Println("something failed")
logHandler.InfoBanner("startup", "init", "application starting")
logHandler.Break()
}
Notes
- Because initialisation happens in
init(), importing this package will create/open the log writers immediately. - Rotation settings (max size, backups, age, compression) are taken from
commonConfig.
Documentation
¶
Overview ¶
Package logHandler centralizes application logging facilities and helpers.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( WarningLogger *log.Logger InfoLogger *log.Logger ErrorLogger *log.Logger PanicLogger *log.Logger TimingLogger *log.Logger EventLogger *log.Logger ServiceLogger *log.Logger TraceLogger *log.Logger AuditLogger *log.Logger TranslationLogger *log.Logger SecurityLogger *log.Logger DatabaseLogger *log.Logger ApiLogger *log.Logger ImportLogger *log.Logger ExportLogger *log.Logger CommunicationsLogger *log.Logger LockLogger *log.Logger CacheLogger *log.Logger )
View Source
var Blue string
View Source
var Cyan string
View Source
var Gray string
View Source
var Green string
View Source
var Magenta string
View Source
var Red string
View Source
var Reset string
View Source
var White string
View Source
var Yellow string
Functions ¶
func InfoBanner ¶
func InfoBanner(logCategory, logActivity, logMessage string)
func ServiceBanner ¶
func ServiceBanner(logCategory, logActivity, logMessage string)
ServiceBanner - log a banner message to the service log Deprecated: No longer to be used
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.