Grand Unified Console [WIP] #8

nblumhardt · 2017-06-05T05:37:13Z

Started work on #7 - just a very basic merge of Serilog.Sinks.Console and Serilog.Sinks.LiterateConsole at this point.

nblumhardt · 2017-06-18T00:36:15Z

10 hours of laptop battery and a flight from Oslo to Brisbane later...

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console()
    .CreateLogger();

As you can see, the default console output now uses the "literate" theme, and has an updated outputTemplate including unquoted/JSON message template rendering.

Here's what the template looks like behind the scenes:

"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"

Original style

The following configuration produces the same output as the original Serilog.Sinks.Console:

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console(
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message}{NewLine}{Exception}",
        theme: ConsoleTheme.None)
    .CreateLogger();

Notice the omission of :lj from {Message}, and the theme parameter. F5:

ANSI output

ANSI themes are supported:

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console(theme: AnsiConsoleTheme.Literate)
    .CreateLogger();

On Win 10, these seem to work from the PowerShell console only, I can't get Visual Studio's F5 experience to work with it (just shows garbage).

The 'literate' theme doesn't transfer to 16-color ANSI very well, but it's passable.

Other

Custom output via formatters such as CompactJsonFormatter is supported (not styled though, of course).

Themes can be created by constructing instances of the SystemConsoleTheme or AnsiConsoleTheme classes. The existing themes can be modified by creating a new style dictionary based on their .Styles properties.

The design of OutputTemplateRenderer is much better than the one I just committed to serilog/serilog, although this one allocates in a couple of places the other doesn't (most prominently in handling the {Properties} special token). The output template is inspected only once at construction, instead of during the rendering of each event. Hoping to take learnings from this exercise to improve the one over there in a future PR.

To do (maybe post-PR, if anyone's keen to get their hands on this and try building some themes, first ;-)):

No tests yet, unfortunately (huge churn while I figured a workable design out)
Monochrome/grayscale ANSI and System Console themes (AnsiConsoleTheme.Gray and SystemConsoleTheme.Gray)
A VS Code-style ANSI theme, maybe 256-color (AnsiConsoleTheme.Code)
~~A WebStorm "Darcula"-style ANSI theme (AnsiConsoleTheme.Storm)~~
~~See if it's possible to get ANSI output working with VS "F5" on Windows 10~~

nblumhardt · 2017-06-18T10:50:15Z

Grayscale

nblumhardt · 2017-06-18T13:15:14Z

Code

nblumhardt · 2017-06-18T13:17:22Z

VS Code-style theme is in; going to call it a day for now. Will add a couple of tests to get the ball rolling, then call this "done".

khellang · 2017-06-18T21:19:57Z

We should detect OS and version and P/Invoke Kernel32's SetConsoleMode to enable VT100 sequences on Windows 10. That should make conhost respect the CSI codes instead of writing garbage. I can PR this later if you want.

merbla · 2017-06-18T21:43:20Z

Should we provide a few sample projects, given the increased options available?

nblumhardt · 2017-06-18T22:04:38Z

Thanks @khellang! I'd searched for something like it but had no luck. Implementing now...

@merbla definitely! I'm running low on time for this one though, perhaps it's one for the backlog?

merbla · 2017-06-18T22:12:37Z

.NET Command Line Tools (1.0.4)

Product Information:
 Version:            1.0.4
 Commit SHA-1 hash:  af1e6684fd

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.11
 OS Platform: Darwin
 RID:         osx.10.11-x64
 Base Path:   /usr/local/share/dotnet/sdk/1.0.4

OSX/ZSH

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console()
    .CreateLogger();

nblumhardt · 2017-06-18T22:17:14Z

Woot! Thanks @merbla 👍

nblumhardt · 2017-06-18T22:17:41Z

@merbla tried the AnsiConsoleTheme.Code variant?

merbla · 2017-06-18T22:48:20Z

.NET Command Line Tools (1.0.4)

Product Information:
 Version:            1.0.4
 Commit SHA-1 hash:  af1e6684fd

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.11
 OS Platform: Darwin
 RID:         osx.10.11-x64
 Base Path:   /usr/local/share/dotnet/sdk/1.0.4

OSX/ZSH

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console(theme: AnsiConsoleTheme.Literate)
    .CreateLogger();

nblumhardt · 2017-06-18T22:50:11Z

👍 ... .Code, though? :-)

merbla · 2017-06-18T22:50:32Z

.NET Command Line Tools (1.0.4)

Product Information:
 Version:            1.0.4
 Commit SHA-1 hash:  af1e6684fd

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.11
 OS Platform: Darwin
 RID:         osx.10.11-x64
 Base Path:   /usr/local/share/dotnet/sdk/1.0.4

OSX/ZSH

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console(
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message}{NewLine}{Exception}",
        theme: ConsoleTheme.None)
    .CreateLogger();

merbla · 2017-06-18T22:53:27Z

.NET Command Line Tools (1.0.4)

Product Information:
 Version:            1.0.4
 Commit SHA-1 hash:  af1e6684fd

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.11
 OS Platform: Darwin
 RID:         osx.10.11-x64
 Base Path:   /usr/local/share/dotnet/sdk/1.0.4

OSX/ZSH

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Verbose()
    .WriteTo.Console(theme: AnsiConsoleTheme.Code)
    .CreateLogger();

nblumhardt · 2017-06-18T22:54:33Z

Success! Though now I am wondering if we can come up with a better theme than that..... :-)

merbla · 2017-06-18T22:58:32Z

Are we thinking this is a 3.0 release of console given the changes? 🙈

nblumhardt · 2017-06-18T23:00:09Z

src/Serilog.Sinks.Console/Serilog.Sinks.Console.csproj

+
+  <PropertyGroup>
+    <Description>A Serilog sink that writes log events to the console/terminal.</Description>
+    <VersionPrefix>3.0.0</VersionPrefix>


@merbla yep :-)

soz missed that one. I was looking for project.json 😜

Still find myself doing that, too.

nblumhardt · 2017-06-18T23:14:24Z

ANSI with Windows 10 cmd.exe (SetConsoleMode() did it, thanks Kristian.)

merbla · 2017-06-18T23:20:56Z

src/Serilog.Sinks.Console/Serilog.Sinks.Console.csproj

+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Serilog" Version="2.5.0-dev-00842" />


Can't forget to circle back to this, post 2.5

merbla · 2017-06-18T23:29:13Z

@nblumhardt when you are comfortable, lets get this in and built for dev.

nblumhardt · 2017-06-18T23:59:58Z

Okay, close enough to "tested" - just exercises the renderers by switching off the theme and running them through the Serilog tests.

There are actually a couple of other potentially-breaking changes here; I think they're reasonably harmless, but ... full disclosure :-)

Rendered objects in display formatting now use C#-style entirely, e.g. {Foo="bar", ...} instead of the old { Foo: "bar", ... } - JSON formatting is the default however, so this makes no difference unless opting into the C#-like "display" syntax
Dictionaries in display formatting have been updated to use new C# syntax, {["Foo"]="bar", ...} instead of [("Foo", "bar"), ...]
Whitespace in display formatting around some punctuation has been trimmed, as above
Non-literal strings now always escape all non-printable characters, e.g. newlines (literal formatting is off by default now, so newlines are emitted directly)

To get 100% full fidelity with version 2 of this sink, you can use:

    .WriteTo.Console(new MessageTemplateTextFormatter(
        "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}",
        null))

This will bypass the custom/themed formatters and use Serilog's built-in formatting, which is as-yet unchanged (I'd like to discuss taking the C#-style object and dictionary syntax back there, too, in another thread :-)).

One tiny dependency version change, then I'll hit the button! Thoughts on the above welcome.

khellang · 2017-06-19T10:49:21Z

Just a thought; what happens with ANSI escape codes when standard output is redirected? Should we also check Console.IsOutputRedirected before emitting them? The .NET Core PAL checks this before emitting escape codes when setting ForegroundColor and BackgroundColor.

nblumhardt · 2017-06-19T21:29:44Z

@khellang thanks 👍 - the check is in: https://github.com/serilog/serilog-sinks-console/blob/dev/src/Serilog.Sinks.Console/ConsoleLoggerConfigurationExtensions.cs#L60

khellang · 2017-06-19T23:10:47Z

Oh, sorry, didn't notice it. Awesome! 😁

hellboy81 · 2018-10-19T10:59:26Z

Which Terminal settings should be applied to display AnsiConsoleTheme.Code output in VS Code itself properly?

At the moment control chars are not interpreted:

khellang · 2018-10-19T11:51:26Z

The VS Code terminal should support ANSI escape codes out of the box. Is that output from a running app?

hellboy81 · 2018-10-19T13:00:08Z

fixed removing using theme parameter.

Is that output from a running app?

yes

nblumhardt added 8 commits June 5, 2017 14:48

Upgrade to RTM dotnet tooling

fd38b89

Updated build/appveyor.yml

76ed0a1

Switched implementation to literate console

dc3b5c8

Sort out special-cased foreground/background coloring

b0ff2de

Complete rewrite

32466e1

ANSI literate theme

9c4f503

Output redirect detection.

76c6e11

Working version

c098412

nblumhardt changed the title ~~Great console unification [WIP]~~ Grand Unified Console [WIP] Jun 18, 2017

nblumhardt added 2 commits June 18, 2017 02:51

Move type to matching filename

cbe5076

Added Grayscale themes (System and ANSI 16-color); cleanup

f8c8d28

AnsiConsoleTheme.Code

969677c

nblumhardt commented Jun 18, 2017

View reviewed changes

Enable ANSI coloring on Windows

e4f61d4

merbla reviewed Jun 18, 2017

View reviewed changes

nblumhardt added 3 commits June 19, 2017 09:31

Themed JSON formatter basic tests

e382585

Themed message template renderer basic tests

dc5ac47

Quick explanatory comment

6ecc782

Update Serilog dependency

5969acc

nblumhardt merged commit c961117 into serilog:dev Jun 19, 2017

nblumhardt mentioned this pull request Jun 21, 2017

3.0.0 Release #11

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Grand Unified Console [WIP] #8

Grand Unified Console [WIP] #8

nblumhardt commented Jun 5, 2017

nblumhardt commented Jun 18, 2017 •

edited

Loading

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

khellang commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017 •

edited

Loading

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt Jun 18, 2017

merbla Jun 18, 2017

nblumhardt Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017 •

edited

Loading

khellang commented Jun 19, 2017 •

edited

Loading

nblumhardt commented Jun 19, 2017

khellang commented Jun 19, 2017

hellboy81 commented Oct 19, 2018 •

edited

Loading

khellang commented Oct 19, 2018

hellboy81 commented Oct 19, 2018 •

edited

Loading

Grand Unified Console [WIP] #8

Grand Unified Console [WIP] #8

Conversation

nblumhardt commented Jun 5, 2017

nblumhardt commented Jun 18, 2017 • edited Loading

Original style

ANSI output

Other

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

khellang commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017 • edited Loading

nblumhardt commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017

merbla commented Jun 18, 2017

nblumhardt Jun 18, 2017

Choose a reason for hiding this comment

merbla Jun 18, 2017

Choose a reason for hiding this comment

nblumhardt Jun 18, 2017

Choose a reason for hiding this comment

nblumhardt commented Jun 18, 2017

merbla Jun 18, 2017

Choose a reason for hiding this comment

merbla commented Jun 18, 2017

nblumhardt commented Jun 18, 2017 • edited Loading

khellang commented Jun 19, 2017 • edited Loading

nblumhardt commented Jun 19, 2017

khellang commented Jun 19, 2017

hellboy81 commented Oct 19, 2018 • edited Loading

khellang commented Oct 19, 2018

hellboy81 commented Oct 19, 2018 • edited Loading

nblumhardt commented Jun 18, 2017 •

edited

Loading

merbla commented Jun 18, 2017 •

edited

Loading

nblumhardt commented Jun 18, 2017 •

edited

Loading

khellang commented Jun 19, 2017 •

edited

Loading

hellboy81 commented Oct 19, 2018 •

edited

Loading

hellboy81 commented Oct 19, 2018 •

edited

Loading