modulepackage
0.0.0-20180821171753-c71e233f94bd
Repository: https://github.com/goinggo/tracelog.git
Documentation: pkg.go.dev
# README
Tracelog
Tracelog sits on top of Go's log library. See the following example for an implementation (it's super easy to use)
Example
package main
import (
"fmt"
"errors"
"github.com/goinggo/tracelog"
)
func main() {
//tracelog.StartFile(tracelog.LevelTrace, "/Users/bill/Temp/logs", 1)
tracelog.Start(tracelog.LevelTrace)
tracelog.Trace("main", "main", "Hello Trace")
tracelog.Info("main", "main", "Hello Info")
tracelog.Warning("main", "main", "Hello Warn")
tracelog.Errorf(fmt.Errorf("Exception At..."), "main", "main", "Hello Error")
Example()
tracelog.Stop()
}
func foo() error {
return errors.New("test")
}
func Example() {
tracelog.Started("main", "Example")
if err := foo(); err != nil {
tracelog.CompletedError(err, "main", "Example")
return
}
tracelog.Completed("main", "Example")
}
Output
TRACE: 2013/11/07 08:24:32 main.go:12: main : main : Info : Hello Trace
INFO: 2013/11/07 08:24:32 main.go:13: main : main : Info : Hello Info
WARNING: 2013/11/07 08:24:32 main.go:14: main : main : Info : Hello Warn
ERROR: 2013/11/07 08:24:32 main.go:15: main : main : Info : Hello Error : Exception At...
TRACE: 2013/11/07 08:24:32 main.go:23: main : Example : Started
TRACE: 2013/11/07 08:24:32 main.go:31: main : Example : Completed
TRACE: 2013/11/07 08:24:32 tracelog.go:149: main : Stop : Started
TRACE: 2013/11/07 08:24:32 tracelog.go:156: main : Stop : Completed
For more details on how to use this package (or to see how it works), see the source. Also, docs
Copyright 2013 Ardan Studios. All rights reserved.
Use of this source code is governed by a BSD-style license that can be found in the LICENSE handle.
Package TraceLog implements a logging system to trace all aspect of your code. This is great for task oriented programs. Based on the Go log standard library. It provides 4 destinations with logging levels plus you can attach a file for persistent writes. A log clean process is provided to maintain disk space. There is also email support to send email alerts.
Ardan Studios
12973 SW 112 ST, Suite 153
Miami, FL 33186
[email protected]
# Functions
Alert write to the Error destination and sends email alert.
Alertcd write to the Error destination and sends email alert.
Completed uses the Serialize destination and writes a Completed tag to the log line.
CompletedAlert write to the Error destination, writes a Completed tag to the log line and sends email alert.
CompletedAlertcd write to the Error destination, writes a Completed tag to the log line and sends email alert.
Completedcd uses the Trace destination and writes a Completed tag to the log line.
CompletedError uses the Error destination and writes a Completed tag to the log line.
CompletedErrorcd uses the Error destination and writes a Completed tag to the log line.
CompletedErrorf uses the Error destination and writes a Completed tag to the log line.
CompletedErrorfcd uses the Error destination and writes a Completed tag to the log line.
Completedf uses the Serialize destination and writes a Completed tag to the log line.
Completedfcd uses the Trace destination and writes a Completed tag to the log line.
ConfigureEmail configures the email system for use.
Error writes to the Error destination and accepts an err.
Errorcd writes to the Error destination and accepts an err.
Errorf writes to the Error destination and accepts an err.
Errorfcd writes to the Error destination and accepts an err.
Info writes to the Info destination.
Infocd writes to the Info destination.
LogLevel returns the configured logging level.
SendEmailException will send an email along with the exception.
Start initializes tracelog and only displays the specified logging level.
Started uses the Serialize destination and adds a Started tag to the log line.
Startedcd uses the Trace destination and adds a Started tag to the log line.
Startedf uses the Serialize destination and writes a Started tag to the log line.
Startedfcd uses the Trace destination and writes a Started tag to the log line.
StartFile initializes tracelog and only displays the specified logging level and creates a file to capture writes.
Stop will release resources and shutdown all processing.
Trace writes to the Trace destination.
Tracecd writes to the Trace destination.
Warning writes to the Warning destination.
Warningcd writes to the Warning destination.
# Constants
LevelError logs just Errors.
LevelInfo logs Info, Warnings and Errors.
LevelTrace logs everything.
LevelWarn logs Warning and Errors.