stratisd icon indicating copy to clipboard operation
stratisd copied to clipboard

Consistent format for debug/log messages

Open agrover opened this issue 6 years ago • 3 comments

We should have a little bit of consistency in the format of these messages, since they will be included in the released product.

We need to come up with a format, apply it to all existing messages, and also document it in the design doc.

agrover avatar Aug 28 '18 17:08 agrover

Content is at least as important as format. Identifiers which help sort out which thinpool, what filesystem, etc. are very important. It is really rough having to try to infer which item a message is most likely to be about based on preceding messages and hypotheses about changes in the call stack that might have occurred in between.

mulkieran avatar Aug 28 '18 17:08 mulkieran

I think we may have to put up with some of that because right now we have layers that don't necessarily know e.g. the pool name of the pool they're operating on, but where possible I agree these should be included.

agrover avatar Aug 28 '18 19:08 agrover

We have lot of functions that are very clear on the pool UUID, though, and could report that. That would really help us distinguish. The UUID is a persistent name (good!) but ugliish. The pool name is volatile, but pleasant in appearance. For a log entry, persistence is key.

mulkieran avatar Aug 28 '18 19:08 mulkieran