Merge pull request #294 from datalust/dev

2023.4 Release

README.md

@@ -54,6 +54,12 @@ $token = (
 
 See `CONTRIBUTING.md`.
 
+## Permissions
+
+When connecting with an API key the allowed operations are determined by the [permissions assigned to that API key](https://docs.datalust.co/docs/api-keys#api-keys-and-permissions).
+
+To determine the permission required for a command check the 'Permission demand' column of the [equivalent server API operation](https://docs.datalust.co/docs/server-http-api). For example, the command `apikey create` uses the [`POST api/apikeys` endpoint](https://docs.datalust.co/docs/server-http-api#apiapikeys), which requires the `Write` permission.
+
 ## Commands
 
 Usage:

appveyor.yml

@@ -1,4 +1,4 @@
-version: 2023.3.{build}
+version: 2023.4.{build}
 skip_tags: true
 image:
 - Visual Studio 2022

global.json

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "7.0.305"
+    "version": "7.0.400"
   }
 }

src/SeqCli/Cli/Commands/IngestCommand.cs

@@ -20,6 +20,7 @@
 using SeqCli.Ingestion;
 using SeqCli.Levels;
 using SeqCli.PlainText;
+using SeqCli.Syntax;
 using Serilog;
 using Serilog.Core;
 using Serilog.Events;
@@ -92,11 +93,7 @@ protected override async Task<int> Run()
             Func<LogEvent, bool>? filter = null;
             if (_filter != null)
             {
-                // Support non-Serilog level names (`@l` can't be overridden by the name resolver). At a later date,
-                // we hope to be able to use the Serilog.Expressions AST to do this reliably (at the moment, all occurrences
-                // of @l, whether referring to the property or not, will be replaced).
-                var expr = _filter.Replace("@l", "@Level").Replace("@Level", $"coalesce(@p['{SurrogateLevelProperty.PropertyName}'],@l)");
-                var eval = SerilogExpression.Compile(expr, nameResolver: new SeqBuiltInNameResolver());
+                var eval = SeqSyntax.CompileExpression(_filter);
                 filter = evt => ExpressionResult.IsTrue(eval(evt));
             }
 

src/SeqCli/SeqCli.csproj

@@ -33,13 +33,13 @@
     <PackageReference Include="Serilog.Formatting.Compact" Version="1.1.0" />
     <PackageReference Include="Serilog.Formatting.Compact.Reader" Version="2.0.0" />
     <PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
-    <PackageReference Include="Autofac" Version="7.0.1" />
+    <PackageReference Include="Autofac" Version="7.1.0" />
     <PackageReference Include="Serilog.Sinks.Seq" Version="5.2.2" />
     <PackageReference Include="Superpower" Version="3.0.0" />
     <PackageReference Include="System.Reactive" Version="6.0.0" />
     <PackageReference Include="System.Security.Cryptography.ProtectedData" Version="7.0.1" />
-    <PackageReference Include="Seq.Api" Version="2023.3.0" />
-    <PackageReference Include="Seq.Apps" Version="2021.4.0" />
+    <PackageReference Include="Seq.Api" Version="2023.4.0" />
+    <PackageReference Include="Seq.Apps" Version="2023.4.0" />
     <PackageReference Include="Tavis.UriTemplates" Version="2.0.0" />
   </ItemGroup>
   <ItemGroup>

src/SeqCli/Ingestion/SeqBuiltInNameResolver.cs → src/SeqCli/Syntax/SeqBuiltInNameResolver.cs

@@ -15,9 +15,7 @@
 using System.Diagnostics.CodeAnalysis;
 using Serilog.Expressions;
 
-#nullable enable
-
-namespace SeqCli.Ingestion;
+namespace SeqCli.Syntax;
 
 /// <summary>
 /// Extends Serilog.Expressions with support for commonly-used Seq property names.
@@ -30,26 +28,26 @@ public override bool TryResolveBuiltInPropertyName(string alias, [NotNullWhen(tr
     {
         switch (alias)
         {
-            case "@Properties":
-                target = "@p";
+            case "Properties":
+                target = "p";
                 return true;
-            case "@Timestamp":
-                target = "@t";
+            case "Timestamp":
+                target = "t";
                 return true;
-            case "@Level":
-                target = "@l";
+            case "Level":
+                target = "l";
                 return true;
-            case "@Message":
-                target = "@m";
+            case "Message":
+                target = "m";
                 return true;
-            case "@MessageTemplate":
-                target = "@mt";
+            case "MessageTemplate":
+                target = "mt";
                 return true;
-            case "@EventType":
-                target = "@i";
+            case "EventType":
+                target = "i";
                 return true;
-            case "@Exception":
-                target = "@x";
+            case "Exception":
+                target = "x";
                 return true;
             default:
                 target = null;

src/SeqCli/Syntax/SeqSyntax.cs

@@ -0,0 +1,16 @@
+using SeqCli.Levels;
+using Serilog.Expressions;
+
+namespace SeqCli.Syntax;
+
+static class SeqSyntax
+{
+    public static CompiledExpression CompileExpression(string expression)
+    {
+        // Support non-Serilog level names (`@l` can't be overridden by the name resolver). At a later date,
+        // we'll use the Seq.Syntax package to do this reliably (at the moment, all occurrences
+        // of @l, whether referring to the property or not, will be replaced).
+        var expr = expression.Replace("@l", "@Level").Replace("@Level", $"coalesce(@p['{SurrogateLevelProperty.PropertyName}'],@l)");
+        return SerilogExpression.Compile(expr, nameResolver: new SeqBuiltInNameResolver());
+    }
+}

test/SeqCli.EndToEnd/SeqCli.EndToEnd.csproj

@@ -5,7 +5,7 @@
     <TargetFrameworks>net7.0;net7.0-windows</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Autofac" Version="7.0.1" />
+    <PackageReference Include="Autofac" Version="7.1.0" />
     <PackageReference Include="xunit" Version="2.5.0" />
     <PackageReference Include="Serilog.Sinks.Seq" Version="5.2.2" />
   </ItemGroup>

test/SeqCli.Tests/SeqCli.Tests.csproj

@@ -3,7 +3,7 @@
     <TargetFrameworks>net7.0;net7.0-windows</TargetFrameworks>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
     <PackageReference Include="xunit" Version="2.5.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0">
       <PrivateAssets>all</PrivateAssets>

test/SeqCli.Tests/Syntax/SeqSyntaxTests.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Linq;
+using SeqCli.Levels;
+using SeqCli.Syntax;
+using Serilog.Events;
+using Serilog.Parsing;
+using Xunit;
+
+namespace SeqCli.Tests.Syntax;
+
+public class SeqSyntaxTests
+{
+    [Fact]
+    public void MessageIsExposed()
+    {
+        var evt = new LogEvent(DateTimeOffset.Now, LogEventLevel.Information, null,
+            new MessageTemplateParser().Parse("Hello"), ArraySegment<LogEventProperty>.Empty);
+
+        var expr = SeqSyntax.CompileExpression("@Message");
+        var result = expr(evt);
+        var scalar = Assert.IsType<ScalarValue>(result);
+        Assert.Equal("Hello", scalar.Value);
+    }
+
+    [Fact]
+    public void SurrogateLevelIsExposed()
+    {
+        var evt = new LogEvent(DateTimeOffset.Now, LogEventLevel.Information, null, new MessageTemplate(Enumerable.Empty<MessageTemplateToken>()), new[]
+        {
+            new LogEventProperty(SurrogateLevelProperty.PropertyName, new ScalarValue("Warning"))
+        });
+
+        var expr = SeqSyntax.CompileExpression("@Level");
+        var result = expr(evt);
+        var scalar = Assert.IsType<ScalarValue>(result);
+        Assert.Equal("Warning", scalar.Value);
+    }
+}