Add an source to all log statements
#103
Conversation
markmandel
force-pushed
the
feature/logging-origin
branch
from
3166019
to
8bd109f
Compare
|
Source or Origin are good. 👍 |
|
So |
cmd/controller/main.go
Outdated
| var ( | ||
| log = runtime.NewLoggerWithOrigin("main") | ||
| ) | ||
|
|
||
| func init() { | ||
| logrus.SetFormatter(&logrus.JSONFormatter{}) |
There was a problem hiding this comment.
Now that the logging concerns are encapsulated within the runtime package, I think it would be nice to move this line into runtime as well. This means all uses of logrus are gathered in a single place.
cmd/controller/main.go
Outdated
| @@ -46,6 +46,10 @@ const ( | |||
| keyFileFlag = "key-file" | |||
| ) | |||
|
|
|||
| var ( | |||
| log = runtime.NewLoggerWithOrigin("main") | |||
There was a problem hiding this comment.
Granted the log package isn't being used here, but to avoid an ambiguity logger might be better.
cmd/sdk-server/main.go
Outdated
| var ( | ||
| log = runtime.NewLoggerWithOrigin("main") | ||
| ) | ||
|
|
||
| func init() { | ||
| logrus.SetFormatter(&logrus.JSONFormatter{}) |
There was a problem hiding this comment.
See above about moving this line into the runtime package as well as renaming log to logger.
|
@Kuqd - I think I like @enocom I like all the above as well, I'll also make those changes. 👍 |
This includes a `logger` as a data members for all objects, which sets a default "source" field on every log statement so that it's easy to track where log messages are coming from. This is particularly useful as the controller for Agones gets more complicated.
markmandel
force-pushed
the
feature/logging-origin
branch
from
8bd109f
to
d99b932
Compare
markmandel
changed the title
origin to all log statementssource to all log statements
|
Changes made! PTAL! |
This includes a
loggeras a data members for all objects, which sets a default "source" field on every log statement so that it's easy to track where log messages are coming from.This is particularly useful as the overall controller for Agones gets more complicated, and we have many interacting controllers in a single binary.
Log statements now look like this:
{"level":"info","msg":"Wait for cache sync","source":"*gameservers.Controller","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Running","origin":"*gameservers.PortAllocator","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Flush cache sync, before syncing gameserver and node state","source":"*gameservers.PortAllocator","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Adding Node to port allocations","node":"agones","source":"*gameservers.PortAllocator","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Resetting Port Allocation","origin":"*gameservers.PortAllocator","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Starting workers...","source":"*gameservers.Controller","time":"2018-02-22T22:58:58Z"} {"level":"info","msg":"Starting worker","source":"*gameservers.HealthController","time":"2018-02-22T22:58:58Z"}So now you can see the context of the log statement through the "source" field.
Would love to hear your thoughts on if this is a good idea, if there is a better word than "origin", or anything else - @dzlier-gcp @enocom @Kuqd