Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Dashboard/RenderCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,7 @@ public RenderCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_connection = Enable<ConnectionFeature>();
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Metrics/DimensionValuesCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,7 +47,7 @@ public DimensionValuesCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();

Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
Expand Down
42 changes: 11 additions & 31 deletions src/SeqCli/Cli/Commands/PrintCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,11 +20,9 @@
using SeqCli.Cli.Features;
using SeqCli.Config;
using SeqCli.Ingestion;
using SeqCli.Output;
using SeqCli.Util;
using Serilog;
using Serilog.Events;
using Serilog.Sinks.SystemConsole.Themes;

namespace SeqCli.Cli.Commands;

Expand All@@ -34,10 +32,10 @@ class PrintCommand : Command
{
readonly FileInputFeature _fileInputFeature;
readonly InvalidDataHandlingFeature _invalidDataHandlingFeature;
readonly OutputFormatFeature _output;
readonly StoragePathFeature _storage;

string? _filter, _template = OutputFormat.DefaultOutputTemplate;
bool? _noColor, _forceColor;
string? _filter, _template;

public PrintCommand()
{
Expand All@@ -53,47 +51,29 @@ public PrintCommand()

_invalidDataHandlingFeature = Enable<InvalidDataHandlingFeature>();

// These should be ported to use `OutputFormatFeature`.
Options.Add("no-color", "Don't colorize text output", _ => _noColor = true);
Options.Add("force-color",
"Force redirected output to have ANSI color (unless `--no-color` is also specified)",
_ => _forceColor = true);
_output = Enable(new OutputFormatFeature(supportNative: false, supportJson: false));

_storage = Enable<StoragePathFeature>();
}

protected override async Task<int> Run()
{
var config = RuntimeConfigurationLoader.Load(_storage);

var applyThemeToRedirectedOutput
= !(_noColor ?? config.Output.DisableColor) && (_forceColor ?? config.Output.ForceColor);

var theme
= _noColor ?? config.Output.DisableColor ? ConsoleTheme.None
: applyThemeToRedirectedOutput ? OutputFormat.DefaultAnsiTheme
: OutputFormat.DefaultTheme;

var outputConfiguration = new LoggerConfiguration()
.MinimumLevel.Is(LevelAlias.Minimum)
.Enrich.With<RedundantEventTypeRemovalEnricher>()
.WriteTo.Console(
outputTemplate: _template ?? OutputFormat.DefaultOutputTemplate,
theme: theme,
applyThemeToRedirectedOutput: applyThemeToRedirectedOutput);

Func<LogEvent, bool>? filter = null;
if (_filter != null)
{
if (!SerilogExpression.TryCompile(_filter, out var filter, out var error))
if (!SerilogExpression.TryCompile(_filter, out var compiled, out var error))
{
Log.Error("The specified filter could not be compiled: {Error}", error);
return 1;
}
outputConfiguration.Filter.ByIncludingOnly(evt => ExpressionResult.IsTrue(filter(evt)));

filter = evt => ExpressionResult.IsTrue(compiled(evt));
}

await using var logger = outputConfiguration.CreateLogger();
var output = _output.GetOutputFormat(config, _template);

foreach (var input in _fileInputFeature.OpenInputs())
{
using (input)
Expand All@@ -108,8 +88,8 @@ var theme
var result = await reader.TryReadAsync();
isAtEnd = result.IsAtEnd;

if (result.LogEvent != null)
logger.Write(result.LogEvent);
if (result.LogEvent != null && (filter == null || filter(result.LogEvent)))
output.WriteLogEvent(result.LogEvent);
}
catch (Exception ex)
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/QueryCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,7 +41,7 @@ public QueryCommand()
_range = Enable<DateRangeFeature>();
_signal = Enable<SignalExpressionFeature>();
_timeout = Enable<TimeoutFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
Options.Add("trace", "Enable detailed (server-side) query tracing", _ => _trace = true);
_connection = Enable<ConnectionFeature>();
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/SearchCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ public SearchCommand()
v => _count = int.Parse(v, CultureInfo.InvariantCulture));

_range = Enable<DateRangeFeature>();
_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();

Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/TailCommand.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,7 +38,7 @@ public TailCommand()
"An optional server-side filter to apply to the stream, for example `@Level = 'Error'`",
v => _filter = v);

_output = Enable(new OutputFormatFeature(supportNative: true));
_output = Enable(new OutputFormatFeature(supportNative: true, supportJson: true));
_storagePath = Enable<StoragePathFeature>();
_signal = Enable<SignalExpressionFeature>();
_connection = Enable<ConnectionFeature>();
Expand Down
26 changes: 13 additions & 13 deletions src/SeqCli/Cli/Features/OutputFormatFeature.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,30 +17,30 @@

namespace SeqCli.Cli.Features;

class OutputFormatFeature(bool supportNative) : CommandFeature
class OutputFormatFeature(bool supportNative, bool supportJson) : CommandFeature
{
OutputSyntax _syntax = OutputSyntax.Text;
bool? _noColor, _forceColor;

// ReSharper disable once UnusedMember.Global
public OutputFormatFeature()
: this(false) { }
: this(supportNative: false, supportJson: true) { }

public OutputFormat GetOutputFormat(SeqCliConfig config)
public OutputFormat GetOutputFormat(SeqCliConfig config, string? outputTemplate = null)
{
return new OutputFormat(
_syntax,
_noColor ?? config.Output.DisableColor,
_forceColor ?? config.Output.ForceColor);
return new OutputFormat(_syntax, _noColor, _forceColor, config.Output, outputTemplate);
}

public override void Enable(OptionSet options)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);

if (supportJson)
{
options.Add(
"json",
"Print output in newline-delimited JSON (the default is plain text)",
_ => _syntax = OutputSyntax.Json);
}

if (supportNative)
{
options.Add(
Expand Down
126 changes: 101 additions & 25 deletions src/SeqCli/Output/OutputFormat.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@
using Seq.Api.Model;
using Seq.Api.Model.Data;
using Seq.Api.Model.Events;
using SeqCli.Config;
using SeqCli.Csv;
using SeqCli.Mapping;
using SeqCli.Util;
Expand All@@ -38,9 +39,23 @@ namespace SeqCli.Output;

sealed class OutputFormat
{
// See https://no-color.org for semantics.
const string NoColorEnvironmentVariable = "NO_COLOR";

internal const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";

static bool AnsiIsDefault => !OperatingSystem.IsWindows();

internal static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;

internal static readonly ConsoleTheme DefaultTheme =
AnsiIsDefault ? DefaultAnsiTheme : SystemConsoleTheme.Literate;

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;

readonly OutputSyntax _syntax;
readonly bool _noColor;
readonly bool _forceColor;
readonly string _outputTemplate;
readonly Logger _formatter;

readonly JsonSerializer _serializer = JsonSerializer.CreateDefault(new JsonSerializerSettings
Expand All@@ -52,39 +67,95 @@ sealed class OutputFormat
}
});

public const string DefaultOutputTemplate =
"[{Timestamp:o} {Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}";
public OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate = null)
: this(
syntax,
noColor,
forceColor,
outputConfig,
outputTemplate,
noColorSetInEnvironment: NoColorSetInEnvironment(),
outputIsRedirected: Console.IsOutputRedirected)
{
}

public static readonly ConsoleTheme DefaultAnsiTheme = AnsiConsoleTheme.Code;
/// <param name="syntax">The syntax to write output in.</param>
/// <param name="noColor">The value of <c>--no-color</c>, if specified.</param>
/// <param name="forceColor">The value of <c>--force-color</c>, if specified.</param>
/// <param name="outputConfig">Configured output defaults.</param>
/// <param name="outputTemplate">The template controlling plain-text formatting, or <c>null</c> for the default.</param>
/// <param name="noColorSetInEnvironment">Whether <c>NO_COLOR</c> is set; see <see cref="NoColorSetInEnvironment"/>.</param>
/// <param name="outputIsRedirected">Whether <c>STDOUT</c> is redirected, i.e. not attached to a terminal.</param>
internal OutputFormat(
OutputSyntax syntax,
bool? noColor,
bool? forceColor,
SeqCliOutputConfig outputConfig,
string? outputTemplate,
bool noColorSetInEnvironment,
bool outputIsRedirected)
{
_syntax = syntax;
_outputTemplate = outputTemplate ?? DefaultOutputTemplate;

public static readonly ConsoleTheme DefaultTheme =
OperatingSystem.IsWindows() ? SystemConsoleTheme.Literate : DefaultAnsiTheme;
NoColor = ResolveNoColor(noColor, forceColor, outputConfig, noColorSetInEnvironment);
ApplyThemeToRedirectedOutput = !NoColor && (forceColor ?? outputConfig.ForceColor);

static readonly TemplateTheme DefaultTemplateTheme = TemplateTheme.Code;
// Serilog's console sink applies the `NO_COLOR` convention itself, unconditionally, overriding whatever
// theme it's passed. When `--force-color` has opted back out of `NO_COLOR`, the variable is cleared (for
// this process only) so that the sink can't undo the decision made here.
if (!NoColor && noColorSetInEnvironment)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this worth the quirky workaround?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we migrate away from using ConsoleTheme this will (thankfully) go away; until then it does at least mean that --force-color works consisently for all commands.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would it take to move away from ConsoleTheme?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not a huge effort, mostly digging into why we haven't been able to do it previously :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll give it a shot tomorrow; want me to fold it in here, or send a follow-up?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can do it as a follow-up, because this is still 90% of what we want either way?

Environment.SetEnvironmentVariable(NoColorEnvironmentVariable, null);

var colorize = !NoColor && (ApplyThemeToRedirectedOutput || !outputIsRedirected);

Theme = !colorize ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;

// Rather than emit escapes that a downlevel Windows terminal would show literally,
// JSON output stays plain there unless ANSI has been opted into with `--force-color`.
TemplateTheme = colorize && (ApplyThemeToRedirectedOutput || AnsiIsDefault)
? DefaultTemplateTheme
: null;

public OutputFormat(OutputSyntax syntax, bool noColor, bool forceColor)
{
_syntax = syntax;
_noColor = noColor;
_forceColor = forceColor;
_formatter = CreateOutputLogger();
}

static bool NoColorSetInEnvironment()
=> !string.IsNullOrEmpty(Environment.GetEnvironmentVariable(NoColorEnvironmentVariable));

static bool ResolveNoColor(
bool? noColorFlag,
bool? forceColorFlag,
SeqCliOutputConfig config,
bool noColorSetInEnvironment)
{
if (noColorFlag != null)
return noColorFlag.Value;

if (config.DisableColor)
return true;

return forceColorFlag != true && noColorSetInEnvironment;
}

public bool Json => _syntax == OutputSyntax.Json;
public bool Text => _syntax == OutputSyntax.Text;
public bool Native => _syntax == OutputSyntax.Native;

bool ApplyThemeToRedirectedOutput => !_noColor && _forceColor;

ConsoleTheme Theme
=> _noColor ? ConsoleTheme.None
: ApplyThemeToRedirectedOutput ? DefaultAnsiTheme
: DefaultTheme;
internal bool NoColor { get; }

bool ApplyThemeToRedirectedOutput { get; }

internal ConsoleTheme Theme { get; }

TemplateTheme? TemplateTheme
=> _noColor ? null
: ApplyThemeToRedirectedOutput ? DefaultTemplateTheme
: null;
internal TemplateTheme? TemplateTheme { get; }

public bool RequiresRender => Native;

Expand All@@ -101,7 +172,7 @@ Logger CreateOutputLogger()
else if (Text)
{
outputConfiguration.WriteTo.Console(
outputTemplate: DefaultOutputTemplate,
outputTemplate: _outputTemplate,
theme: Theme,
applyThemeToRedirectedOutput: ApplyThemeToRedirectedOutput);
}
Expand DownExpand Up@@ -219,10 +290,15 @@ public void WriteEventEntity(EventEntity evt)
}
else
{
_formatter.Write(ToSerilogEvent(evt));
WriteLogEvent(ToSerilogEvent(evt));
}
}

public void WriteLogEvent(LogEvent logEvent)
{
_formatter.Write(logEvent);
}

public static LogEvent ToSerilogEvent(EventEntity evt)
{
ActivityTraceId traceId = default;
Expand Down
4 changes: 3 additions & 1 deletion src/SeqCli/Output/OutputFormatter.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ static class OutputFormatter
// Emit a log or span
$"{{@t, @mt, @l: coalesce({LevelMapping.SurrogateLevelProperty}, if @l = 'Information' then undefined() else @l), @x, @sp, @tr, @ps: coalesce({TraceConstants.ParentSpanIdProperty}, @ps), @st: coalesce({TraceConstants.SpanStartTimestampProperty}, @st), ..rest()}} " +
$"}}\n",
theme: theme
theme: theme,
// The `OutputFormat` constructor has already decided whether to colorize.
applyThemeWhenOutputIsRedirected: true
);
}
Loading