tree 478ba236eae88852d11623b6a58a8f92cc469e5f
parent 80c973cbd508f4588db57630eb83be1242c95fb3
author Kun Zhang <zhangkun83@users.noreply.github.com> 1541551689 -0800
committer GitHub <noreply@github.com> 1541551689 -0800
gpgsig -----BEGIN PGP SIGNATURE-----
 
 wsBcBAABCAAQBQJb4jZJCRBK7hj4Ov3rIwAAdHIIAEFDnTNrR8Ywx73jg/QmSXjk
 wI5oe0AvNXxPS6jewgpplw7x9sCgqbZrmPX6n/npfUYWxui3949LGeWlXvE58Wn8
 h4IQY3MII0TkCr6j4+RUASYEfX6u2v99L3E3SNfY2dGgnhX6Qiu+sM+AEcgcGxx4
 9XnMADjqZEJ+5/eyKiRP+jFV2ZMMH9nWmm1oFIDJptZkgjYka21wzk+utUf6nXX9
 AjnflJld15j1hoM9WRHhtQMBDRrJOcFytqqY0bYSQdUaCIa7EofhN440hUUJJHLF
 zroJ51BajsZtGsyCChVmaUmHe1X5McB+tohHecoXopmd7BsEvx05HXDiYafog4k=
 =xRv0
 -----END PGP SIGNATURE-----
 

core: ChannelLogger (#5024)

Introduce ChannelLogger, which is a utility provided to LoadBalancer implementations (potentially NameResolvers too) for recording events to channel trace. This is immediately required by client-side health checking (#4932, https://github.com/grpc/proposal/blob/master/A17-client-side-health-checking.md) to record an error about disabling health checking. It is also useful for any LoadBalancer implementations to record important information.

ChannelLogger implementation is backed by the internal ChannelTracer/Channelz. Because Channelz limits the number of retained events, and events are lost once the process ends, I have expanded it to also log Java logger. This would provide a "last resort" in cases where there are too many events or off-line investigation is needed. All logs are prefixed with logId so that they can be easily associated with the involved Channel/Subchannel.

To prevent log spamming, the logs are all at FINE level or below so that they are not visible by default. They are logged to ChannelLogger's logger, so that user can have precise control.

There are also more verbose information that may not fit in ChannelTracer, but can be useful for debugging. It's desirable that these logs are associated with logId, but they currently manually include the logId, which is cumbersome and may result in inconsistency. For this use case, I added the DEBUG level for ChannelLogger, which formats the log in the same way as other levels, while not recorded to Channelz.

I have converted most logging and channel tracer recording in the Channel implementation and LoadBalancers.