Logger update #1213

notzippy · 2017-07-26T05:23:16Z

This logger provides context logging for the controller, and it provides the ability to output in either json or text file format. Log messages and key value pairs. File rotation is also handled based on either the file size or the number of days specified in the app.config

Logging

By default a new logger is available for the application called revel.AppLog - its interface is using the log15 interface (see here) You can assign log handlers which can perform multiple functions.

NOTE The new logger expects message values in key value pairs. For example revel.AppLog.Debug("Hi there") is fine revel.AppLog.Debug("Hi there", 25) will panic (only passed one argument for the context). revel.AppLog.Debug("Hi there","age",25,"sex","yes","state",254) is fine. and will produce a log message that includes the context age,sex,state.

The logger in the controller adds the ability to extend its context so you can say c.Log = c.Log.New("user",userid) and all subsequent logs using that controller will report the 'user'=userid in the log files. Each request instance in the controller will create a new log context so all your logs messages during the request will be unique. Revel create the c.Log using a context that includes the ip, request path and request method

Default operation

By default it operates the same as the old logging utility. Unless the log file ends in json , in that case the log output will be in json format. Log file size is limited to 10G in size but may be specified in app.conf log.maxsize (in MB). Log file age is limited to 14 days be default unless specified in app.conf log.maxage (in days). If either is exceeded the file is date stamped and a new file is created.

Deprecated loggers

revel.ERROR,revel.WARN,revel.INFO,revel.TRACE, are deprecated. Controllers in applications should log to the context logger controller.Log and jobs should log to revel.AppLog

Sample Screen Shot

TODO

Go through revel remove all references to deprecated loggers
docs for new app.conf

brendensoares · 2017-08-02T04:37:46Z

logger.go

+	Level  log15.Lvl
+}
+
+func (s loggerRewrite) Write(p []byte) (n int, err error) {


need explicit deprecation message to be painfully clear to revel users when running code that uses this deprecated code

s vs lr?

brendensoares · 2017-08-02T05:27:42Z

logger.go

+// INFO  2017/07/25 14:53:40 db.go:768: [gorp] begin; [] (138.433µs)
+func terminalFormat(noColor bool) log15.Format {
+	return log15.FormatFunc(func(r *log15.Record) []byte {
+		var color = 0


add comments for what colors these correspond to

brendensoares · 2017-08-02T05:28:11Z

logger.go

+				k, v = errorKey, formatLogfmtValue(k)
+			}
+
+			// XXX: we should probably check that all of your key bytes aren't invalid


XXX? Maybe TODO

brendensoares · 2017-08-02T05:28:54Z

logger.go

+		b := &bytes.Buffer{}
+		lvl := strings.ToUpper(r.Lvl.String())
+		if noColor == false && color > 0 {
+			// fn := findInContext("fn",r.Ctx)


brendensoares · 2017-08-02T05:29:02Z

logger.go

+			fmt.Fprintf(b, "[%s] [%s] %s ", lvl, r.Time.Format(termTimeFormat), r.Msg)
+		}
+
+		// try to justify the log output for short messages


brendensoares · 2017-08-02T05:33:57Z

server-engine.go

@@ -154,13 +156,10 @@ func handleInternal(ctx ServerContext) {
 	// RequestStartTime ClientIP ResponseStatus RequestLatency HTTPMethod URLPath
 	// Sample format:
 	// 2016/05/25 17:46:37.112 127.0.0.1 200  270.157µs GET /


Update the comment

On controller creation a logger is attached to the controller, this logger has contextual information like the clientIp, request path, etc etc. Every log message sent to this logger will add this to the log message Added ability to log to json files. If log file ends in json then the logger will write to that file Added ability to define logger.maxsize (in mega bytes) defaults to 10G Added ability to define logger.maxage (in days) defaults to 7 If either of those values are exceeded the log file is rotated - ie the old is renamed and a new one is created

notzippy · 2017-08-04T20:44:47Z

@brendensoares Did a bigger update to the code base - I moved most of the logger code inside a revel/logger package and broke out the code into separate files. There still is a revel/logger.go file which defines the global loggers but in general it is cleaner. Can you have a quick peek again ?

On controller creation a logger is attached to the controller, this logger has contextual information like the clientIp, request path, etc etc. Every log message sent to this logger will add this to the log message Added ability to log to json files. If log file ends in json then the logger will write to that file Added ability to define logger.maxsize (in mega bytes) defaults to 10G Added ability to define logger.maxage (in days) defaults to 7 If either of those values are exceeded the log file is rotated - ie the old is renamed and a new one is created Logger implementation is contained inside of the revel/logger package Added defaults so logging was not discarded (when used by the revel harness)

zuoRambo · 2017-08-17T10:58:24Z

I think revel.TRACE revel.INFO revel.WARN revel.ERROR should keep.
And seperate controller log and job log is a good idea! 👍

notzippy · 2017-08-17T16:22:11Z

@zuoRambo thanks for the feedback - The reason we choose to deprecate those variables is because the functionality is contained inside the revel.AppLog, revel.AppLog.Error("message") revel.AppLog.Warn("message") revel.AppLog.Debug("message") revel.AppLog.Info("message") revel.AppLog.Crit("message"). Since they are contained there we should not expose a duplicate method elsewhere.

I realize it may be some work to switch over existing applications to use the new logging, but with the new logging you get some extended features like JSON log records with field/values.

Let me know if you have more reasons for revel.ERROR log messages to remain open

# Conflicts: # template.go

notzippy added this to the v0.18 milestone Jul 26, 2017

notzippy added waffle: ready and removed waffle: ready labels Jul 26, 2017

notzippy force-pushed the logger branch from 679f8a4 to 5e9dfe0 Compare July 26, 2017 22:08

This was referenced Jul 26, 2017

Modular, driver-based logger interface #316

Closed

Feature: revel command terminal color support #407

Closed

Make getLogger public and allow it to be overridden #557

Closed

Log to syslog #676

Closed

Any function for log rotate? #568

Closed

notzippy added the type-feature New feature request label Aug 1, 2017

brendensoares requested changes Aug 2, 2017

View reviewed changes

notzippy added status-doing Implementation has started and removed waffle: needs review labels Aug 2, 2017

notzippy force-pushed the logger branch 3 times, most recently from 7f7fb80 to b7ef138 Compare August 4, 2017 02:59

notzippy added waffle: needs review and removed status-doing Implementation has started labels Aug 4, 2017

notzippy force-pushed the logger branch 2 times, most recently from 9ff6c36 to b65288f Compare August 11, 2017 06:07

notzippy mentioned this pull request Aug 17, 2017

some suggestions for improvement #1222

Closed

notzippy added status-doing Implementation has started and removed waffle: needs review labels Aug 19, 2017

Updated revel to use new Logger

92af726

notzippy force-pushed the logger branch from b65288f to 92af726 Compare August 25, 2017 23:08

notzippy added waffle: needs review and removed status-doing Implementation has started waffle: needs review labels Aug 26, 2017

brendensoares approved these changes Aug 26, 2017

View reviewed changes

Merge branch 'develop' of git://github.com/revel/revel into logger

27cfe0c

# Conflicts: # template.go

notzippy force-pushed the logger branch from 9575dfb to 27cfe0c Compare August 26, 2017 13:58

notzippy merged commit bcb9acd into revel:develop Aug 26, 2017

notzippy removed the waffle: approved label Aug 26, 2017

notzippy mentioned this pull request Sep 5, 2017

Unable to show error string with log15 #1232

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Logger update #1213

Logger update #1213

Uh oh!

notzippy commented Jul 26, 2017 •

edited

Loading

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

brendensoares Aug 2, 2017

Uh oh!

notzippy commented Aug 4, 2017

Uh oh!

zuoRambo commented Aug 17, 2017

Uh oh!

notzippy commented Aug 17, 2017

Uh oh!

Uh oh!

Logger update #1213

Logger update #1213

Uh oh!

Conversation

notzippy commented Jul 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Logging

Default operation

Deprecated loggers

TODO

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

brendensoares Aug 2, 2017

Choose a reason for hiding this comment

Uh oh!

notzippy commented Aug 4, 2017

Uh oh!

zuoRambo commented Aug 17, 2017

Uh oh!

notzippy commented Aug 17, 2017

Uh oh!

Uh oh!

notzippy commented Jul 26, 2017 •

edited

Loading