formatting logs for structured data #70
Conversation
| foreach (var kvp in values) | ||
| { | ||
| builder.Append("\r\n"); | ||
| for (var i = 0; i < level; i++) |
There was a problem hiding this comment.
builder.Append(new string('\t', level))?
There was a problem hiding this comment.
I didn't know about this method, I like it 👍
| foreach (var kvp in values) | ||
| { | ||
| builder.Append("\r\n"); | ||
| builder.Append('\t', level); |
There was a problem hiding this comment.
Tabs might be overkill, especially if you end up with a deeply nested object. How does it look with just two or three spaces?
There was a problem hiding this comment.
wow I didn't realize the default tab was like 8 spaces. That's insane!
|
@Tratcher this is what it looks like with 3 spaces |
|
|
||
| namespace Microsoft.Framework.Logging.Console | ||
| { | ||
| public class ConsoleLogger : ILogger | ||
| { | ||
| private const int _indentation = 3; |
There was a problem hiding this comment.
Somewhat nitpicky, but 3 is such an odd number (literally!). 2 or 4 are more common indentation levels...
…pport for general IEnumerables
| if (formatter != null) | ||
| if (state is ILoggerStructure) | ||
| { | ||
| var builder = FormatLoggerStructure(new StringBuilder(), (ILoggerStructure)state, 1, false); |
| { | ||
| if (value is ILoggerStructure) | ||
| { | ||
| builder = FormatLoggerStructure(builder, (ILoggerStructure)value, level + 1, true); |
|
Just glazed over it, don't wait on me for anything though 😄 |
| @@ -98,5 +111,60 @@ public IDisposable BeginScope(object state) | |||
| { | |||
| return null; | |||
| } | |||
|
|
|||
| private StringBuilder FormatLoggerStructure(StringBuilder builder, ILoggerStructure structure, int level, bool bullet) | |||
There was a problem hiding this comment.
Chatted in person. This doesn't need to return the StringBuilder because it's always the same instance. Just pass it around as a parameter.
| { | ||
| var builder = new StringBuilder(); | ||
| FormatLoggerStructure( | ||
| builder: builder, |
There was a problem hiding this comment.
No need to provide a named parameter for the builder or state since their names state their purpose. General rule: If you can't decipher what a parameter to a method is, provide a named parameter. So things like true, 1234 etc. are just values with no information and don't inform the reader of anything. Same comment for other instances in this file.
|
|
after 
If the state of a log message is an
ILoggerStructure, the console logger will display the result ofGetValues, oneKeyValuePairper line. It does this recursively for cases where theValueis anILoggerStructureor anIEnumerable<ILoggerStructure>