Some key-value is missing in the log

[cshuaimin]

handlers.go line 301:

lm := make(lgbl.DeferredMap)
lm["peer"] = func() interface{} { return p.Pretty() }
eip := log.EventBegin(ctx, "handleGetProviders", lm)
defer eip.Done()
// ...
lm["key"] = func() interface{} { return c.String() }

The last line does not work and the key does not appear in the log message. And I see that the EventBegin has been deprecated, so I changed all EventBegin to Start.

[Stebalien]

Thanks!

[Stebalien]

This should probably be log.SetTag(ctx, "peer", p).

1. LogKV is more for events/log items. SetTag will set the "peer" property for the event.
2. Pretty will convert to base58 (slow).

[cshuaimin]

I know lots of base58 encoding is too slow, but without this, the output will be:

{<...>, "Tags":{"peer":"\u0012 =\ufffd\ufffd\ufffd\n\ufffds}\ufffdGpnc0\ufffd\ufffd\ufffdhc\ufffd,}\ufffd\"\ufffd\u000c\ufffd\u0000ږ\ufffd\u0005","system":"dht"},"Logs":[{"Timestamp":"2018-08-24T10:51:23.56479413+08:00","Fields":[{"Key":"key","Value":"QmVYL1EPRThV5pg2Vybz2kxuCzyUcmvvRZXToQqs4aSxBn"}]}]}

Should we use Pretty?

[Stebalien]

That looks like a bug. Our logger should be calling String().

[Stebalien]

Fixed here: ipfs/go-log#45.

[Stebalien]

You can actually skip the SetErr now and:

1. Set a named error return value (e.g., _err). This'll "capture" the err return value in a variable and make it accessible from deferred functions.
2. Use defer func() { log.FinishWithErr(ctx, _err) }

But that's up to you.

[cshuaimin]

So clever way! Thanks for your idea.

[dokterbob]

Hey, this one looks ready for merge to me. Note that this is a fix allowing the currently broken sniffer for ipfs-search to function again - so I can upgrade IPFS to 0.4.17, finally! :)

[Stebalien]

Not quite. We need to actually update go-log.

[dokterbob]

Thanks! Now let's hope it makes it into IPFS soon. ^^

[Stebalien]

This one's pretty easy to update.