slog: update to use structured logs for hashmail server #148
Conversation
ellemouton
force-pushed
the
slog
branch
3 times, most recently
from
550bede to
50cbe19
Compare
hashmail_server.go
Outdated
| log.DebugS(ctxl, "New HashMail stream init", "auth", init.Auth) | ||
|
|
||
| if err := h.ValidateStreamAuth(ctxl, init); err != nil { | ||
| log.DebugS(ctxl, "Stream creation validation failed", err) |
There was a problem hiding this comment.
I think this needs to be "err", err, otherwise this would show as "bad key", because DebugS doesn't have an err parameter. Same further below.
There was a problem hiding this comment.
a yes good catch!
makes me wonder if we should switch this to a "WarnS"? but anyways, keeping it as debug for now 👍
ellemouton
force-pushed
the
slog
branch
3 times, most recently
from
2a10761 to
8cd2863
Compare
hashmail_server.go
Outdated
| @@ -621,6 +629,9 @@ func (h *hashMailServer) SendStream(readStream hashmailrpc.HashMail_SendStreamSe | |||
| return err | |||
| } | |||
|
|
|||
| ctx := btclog.WithCtx(readStream.Context(), | |||
There was a problem hiding this comment.
nit: this is a normal (non-formatting) function call, so I think the other multi-line formatting rule would apply?
Same further below.
| # Console and file logger settings. | ||
| logging: | ||
| console: | ||
| disable: false | ||
| call-site: short | ||
| file: | ||
| disable: true | ||
| call-site: long |
There was a problem hiding this comment.
yaml parser is struggling with these 🙃
There was a problem hiding this comment.
Could be reserved words. Try `'short' and 'long' instead?
There was a problem hiding this comment.
it isnt just the call-site. it is anything from that unexported empedded struct. only works for the 'style' option when compiled in 'dev' mode.
seems to be a yaml issue (cause things work for the lnd.conf file just fine)
|
I think we need to bump the Golang version in the linter docker file. |
ellemouton
force-pushed
the
slog
branch
5 times, most recently
from
77d1c27 to
b3ff32b
Compare
| # Console and file logger settings. | ||
| logging: | ||
| console: | ||
| disable: false | ||
| call-site: short | ||
| file: | ||
| disable: true | ||
| call-site: long |
There was a problem hiding this comment.
Could be reserved words. Try `'short' and 'long' instead?
|
struggling with this linter 🙃 will try some iterations locally |
|
ooo ok im winning now! gimme a min |
Update the deps so that structured logging is available in aperture.
This will make querying by stream IDs more uniform (and hence, way easier).
|
YAY linter happy |
| _ = build.ParseAndSetDebugLevels("trace,PRXY=warn", logWriter) | ||
| logMgr := build.NewSubLoggerManager(btclog.NewDefaultHandler(os.Stdout)) | ||
| SetupLoggers(logMgr, signal.Interceptor{}) | ||
| _ = build.ParseAndSetDebugLevels("trace,PRXY=warn", logMgr) |
There was a problem hiding this comment.
I propose to check error from ParseAndSetDebugLevels. We can panic if it return an error.
| SetupLoggers(logWriter, interceptor) | ||
| sugLogMgr = build.NewSubLoggerManager( | ||
| build.NewDefaultLogHandlers(cfg.Logging, logWriter)..., | ||
| ) |
There was a problem hiding this comment.
SetupLoggers also assigns global sugLogMgr variable. So we assign it twice: here and inside SetupLoggers. Does it make sense to create a local variable here and to pass it to SetupLoggers and let it assign the global variable there?
Also, can we just remove sugLogMgr (global var)? It seems that it is not used anywhere, only assigned to.
Update aperture's btclog and lnd deps so that it can take advantage of structure logging.
Then start using the structured logs for the hashmail server.
This will make querying logs much easier & faster.
Example
Main thing to note here is the uniformity of the "stream_id" attribute in the new logs.
Old:
New: