Level label is excluded by default

mishamyte · mishamyte · commit 534840eba0f9 · 2021-08-15T19:40:31.000+03:00
diff --git a/src/Serilog.Sinks.Grafana.Loki/LoggerConfigurationLokiExtensions.cs b/src/Serilog.Sinks.Grafana.Loki/LoggerConfigurationLokiExtensions.cs
@@ -79,6 +79,10 @@ public static class LoggerConfigurationLokiExtensions
         /// A custom <see cref="ILokiHttpClient"/> implementation. Default value is
         /// <see cref="LokiHttpClient"/>.
         /// </param>
+        /// <param name="createLevelLabel">
+        /// Should level label be created. Default value is false
+        /// The level label always won't be created while using <see cref="ILabelAwareTextFormatter"/>
+        /// </param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         public static LoggerConfiguration GrafanaLoki(
             this LoggerSinkConfiguration sinkConfiguration,
@@ -93,14 +97,15 @@ public static LoggerConfiguration GrafanaLoki(
             int? queueLimit = null,
             TimeSpan? period = null,
             ITextFormatter? textFormatter = null,
-            ILokiHttpClient? httpClient = null)
+            ILokiHttpClient? httpClient = null,
+            bool createLevelLabel = false)
         {
             if (sinkConfiguration == null)
             {
                 throw new ArgumentNullException(nameof(sinkConfiguration));
             }
 
-            var createLevelLabel = textFormatter is not ILabelAwareTextFormatter {ExcludeLevelLabel: true};
+            createLevelLabel = createLevelLabel && textFormatter is not ILabelAwareTextFormatter {ExcludeLevelLabel: true};
             var batchFormatter = new LokiBatchFormatter(labels, filtrationMode, filtrationLabels, createLevelLabel);
 
             period ??= TimeSpan.FromSeconds(1);
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.DifferentLevelsShouldNotGenerateDifferentStreamsWithoutLevelLabel.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.DifferentLevelsShouldNotGenerateDifferentStreamsWithoutLevelLabel.approved.txt
@@ -0,0 +1 @@
+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","This is an information without params"],["<unixepochinnanoseconds>","This is an error without params"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.EntryShouldBeRenderedAccordingToOutputTemplate.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.EntryShouldBeRenderedAccordingToOutputTemplate.approved.txt
@@ -1 +1 @@
-﻿{"streams":[{"stream":{"level":"error"},"values":[["<unixepochinnanoseconds>","[ERR] An error occured"]]}]}
+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","[ERR] An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.ExcludedLabelsShouldNotBePresentInRequest.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.ExcludedLabelsShouldNotBePresentInRequest.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"level":"error","server_name":"loki_test"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
+{"streams":[{"stream":{"server_name":"loki_test"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.GlobalLabelsShouldNotBeFiltered.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.GlobalLabelsShouldNotBeFiltered.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"server_ip":"127.0.0.1","level":"error"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
+{"streams":[{"stream":{"server_ip":"127.0.0.1"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LabelsForIndexedPlaceholdersShouldBeCreatedWithParamPrefix.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LabelsForIndexedPlaceholdersShouldBeCreatedWithParamPrefix.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"level":"info","Param-0":"Namespace.Module.Method"},"values":[["<unixepochinnanoseconds>","An error occured in \u0022Namespace.Module.Method\u0022"]]}]}
+{"streams":[{"stream":{"Param-0":"Namespace.Module.Method"},"values":[["<unixepochinnanoseconds>","An error occured in \u0022Namespace.Module.Method\u0022"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LevelLabelShouldBeCreatedCorrectly.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LevelLabelShouldBeCreatedCorrectly.approved.txt
@@ -0,0 +1 @@
+{"streams":[{"stream":{"level":"error"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LevelLabelShouldGenerateNewGroupAndStream.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.LevelLabelShouldGenerateNewGroupAndStream.approved.txt
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.OnlyIncludedLabelsShouldBePresentInRequest.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.OnlyIncludedLabelsShouldBePresentInRequest.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"level":"error","server_ip":"127.0.0.1"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
+{"streams":[{"stream":{"server_ip":"127.0.0.1"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.ParameterShouldGenerateNewGroupAndStream.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.ParameterShouldGenerateNewGroupAndStream.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"level":"info"},"values":[["<unixepochinnanoseconds>","What is the meaning of life?"]]},{"stream":{"level":"info","MeaningOfLife":"42"},"values":[["<unixepochinnanoseconds>","The meaning of life is 42"]]}]}
+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","What is the meaning of life?"]]},{"stream":{"MeaningOfLife":"42"},"values":[["<unixepochinnanoseconds>","The meaning of life is 42"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.RequestContentShouldMatchApproved.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.RequestContentShouldMatchApproved.approved.txt
@@ -1 +1 @@
-﻿{"streams":[{"stream":{"level":"error"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.SameGroupLabelsShouldBeInTheSameStreams.approved.txt b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/Approvals/RequestPayloadTests.SameGroupLabelsShouldBeInTheSameStreams.approved.txt
@@ -1 +1 @@
-{"streams":[{"stream":{"level":"info"},"values":[["<unixepochinnanoseconds>","This is an information without params"],["<unixepochinnanoseconds>","This is also an information without params"]]}]}
+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","This is an information without params"],["<unixepochinnanoseconds>","This is also an information without params"]]}]}
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/RequestPayloadTests.cs b/test/Serilog.Sinks.Grafana.Loki.Tests/IntegrationTests/RequestPayloadTests.cs
@@ -40,6 +40,27 @@ public void RequestContentShouldMatchApproved()
             });
         }
 
+        [Fact]
+        public void LevelLabelShouldBeCreatedCorrectly()
+        {
+            var logger = new LoggerConfiguration()
+                .WriteTo.GrafanaLoki(
+                    "https://loki:3100",
+                    outputTemplate: OutputTemplate,
+                    httpClient: _client,
+                    createLevelLabel: true)
+                .CreateLogger();
+
+            logger.Error("An error occured");
+            logger.Dispose();
+
+            _client.Content.ShouldMatchApproved(c =>
+            {
+                c.SubFolder(ApprovalsFolderName);
+                c.WithScrubber(s => Regex.Replace(s, "\"[0-9]{19}\"", "\"<unixepochinnanoseconds>\""));
+            });
+        }
+
         [Fact]
         public void OnlyIncludedLabelsShouldBePresentInRequest()
         {
@@ -154,7 +175,7 @@ public void SameGroupLabelsShouldBeInTheSameStreams()
         }
 
         [Fact]
-        public void DifferentGroupLabelsShouldBeInDifferentStreams()
+        public void DifferentLevelsShouldNotGenerateDifferentStreamsWithoutLevelLabel()
         {
             var logger = new LoggerConfiguration()
                 .WriteTo.GrafanaLoki(
@@ -175,6 +196,29 @@ public void DifferentGroupLabelsShouldBeInDifferentStreams()
             });
         }
 
+        [Fact]
+        public void LevelLabelShouldGenerateNewGroupAndStream()
+        {
+            var logger = new LoggerConfiguration()
+                .WriteTo.GrafanaLoki(
+                    "https://loki:3100",
+                    outputTemplate: OutputTemplate,
+                    period: BatchPeriod,
+                    httpClient: _client,
+                    createLevelLabel: true)
+                .CreateLogger();
+
+            logger.Information("This is an information without params");
+            logger.Error("This is an error without params");
+            logger.Dispose();
+
+            _client.Content.ShouldMatchApproved(c =>
+            {
+                c.SubFolder(ApprovalsFolderName);
+                c.WithScrubber(s => Regex.Replace(s, "\"[0-9]{19}\"", "\"<unixepochinnanoseconds>\""));
+            });
+        }
+
         [Fact]
         public void ParameterShouldGenerateNewGroupAndStream()
         {
diff --git a/test/Serilog.Sinks.Grafana.Loki.Tests/Serilog.Sinks.Grafana.Loki.Tests.csproj b/test/Serilog.Sinks.Grafana.Loki.Tests/Serilog.Sinks.Grafana.Loki.Tests.csproj
@@ -7,7 +7,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
         <PackageReference Include="Shouldly" Version="4.0.3" />
         <PackageReference Include="xunit" Version="2.4.1" />
         <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","This is an information without params"],["<unixepochinnanoseconds>","This is an error without params"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"streams":[{"stream":{"level":"error"},"values":[["<unixepochinnanoseconds>","[ERR] An error occured"]]}]}`
	`1`	`+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","[ERR] An error occured"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"streams":[{"stream":{"level":"error","server_name":"loki_test"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}`
	`1`	`+{"streams":[{"stream":{"server_name":"loki_test"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"streams":[{"stream":{"server_ip":"127.0.0.1","level":"error"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}`
	`1`	`+{"streams":[{"stream":{"server_ip":"127.0.0.1"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"streams":[{"stream":{"level":"info","Param-0":"Namespace.Module.Method"},"values":[["<unixepochinnanoseconds>","An error occured in \u0022Namespace.Module.Method\u0022"]]}]}`
	`1`	`+{"streams":[{"stream":{"Param-0":"Namespace.Module.Method"},"values":[["<unixepochinnanoseconds>","An error occured in \u0022Namespace.Module.Method\u0022"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"streams":[{"stream":{"level":"error"},"values":[["<unixepochinnanoseconds>","An error occured"]]}]}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"streams":[{"stream":{"level":"info"},"values":[["<unixepochinnanoseconds>","What is the meaning of life?"]]},{"stream":{"level":"info","MeaningOfLife":"42"},"values":[["<unixepochinnanoseconds>","The meaning of life is 42"]]}]}`
	`1`	`+{"streams":[{"stream":{},"values":[["<unixepochinnanoseconds>","What is the meaning of life?"]]},{"stream":{"MeaningOfLife":"42"},"values":[["<unixepochinnanoseconds>","The meaning of life is 42"]]}]}`