Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In an log entry, we usually needs to include the related following information:

  1. Related local / global variable's values within the function / code block

...

  1. .
  2.  for example, the fetch request string for logging "request handling failures", the current replicas LEO values when advancing the partition HW accordingly, etc.

And here are a few general rules we take for logging format:

  1. Each logging entry is usually one-line for the ease of text parsing tools upon trouble shooting, unless it will cause a very long line that may span over multiple screens (for example, the topic-change listener firing log, that may contain hundreds of partitions information).

Also, the logging indent need to be concise and self-distinctive (this is usually also related to client id naming).

...