feat: add support for dynatrace (#112)

loekensgard · h3rmanj · web-flow · commit b53c1fed91bc · 2023-10-26T14:49:39.000+02:00
* feat: add dynatrace sink extension

* fix: set serilog.aspnetcore version by conditional targetframework

* fix: use recommended way to read configuration

* build: bump nuke to .net 7

* fix: new nuke syntax

---------

Co-authored-by: Herman Jensen &lt;herman.jensen@intility.no&gt;
diff --git a/.github/workflows/compile.yaml b/.github/workflows/compile.yaml
@@ -17,10 +17,10 @@ jobs:
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
-    - name: Setup .NET 6
+    - name: Setup .NET 7
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 6.0.*
+        dotnet-version: 7.0.*
     - name: Build with Nuke
       run: ./build.sh compile
       shell: bash
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -15,10 +15,10 @@ jobs:
       with:
         fetch-depth: 0
 
-    - name: Setup .NET 6
+    - name: Setup .NET 7
       uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 6.0.*
+        dotnet-version: 7.0.*
 
     - name: Publish to NuGet with Nuke
       run: ./build.sh push --nuget-api-key ${{ secrets.NUGET_API_KEY }}
diff --git a/.nuke/build.schema.json b/.nuke/build.schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "Build Schema",
   "$ref": "#/definitions/build",
+  "title": "Build Schema",
   "definitions": {
     "build": {
       "type": "object",
@@ -119,4 +119,4 @@
       }
     }
   }
-}
+}
diff --git a/Intility.Logging.sln b/Intility.Logging.sln
@@ -22,7 +22,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WebSample", "samples\WebSam
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WorkerSample", "samples\WorkerSample\WorkerSample.csproj", "{25312E6A-4BA3-4FDF-AA7C-CF2A10CDA2AA}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MinimalApiSample", "samples\MinimalApiSample\MinimalApiSample.csproj", "{B647AC70-7210-462A-A43C-6EB4AFCB7ED4}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MinimalApiSample", "samples\MinimalApiSample\MinimalApiSample.csproj", "{B647AC70-7210-462A-A43C-6EB4AFCB7ED4}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Intility.Extensions.Logging.Dynatrace", "src\Intility.Extensions.Logging.Dynatrace\Intility.Extensions.Logging.Dynatrace.csproj", "{B94B9317-E255-4851-9110-0366906EA8A8}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -118,6 +120,18 @@ Global
 		{B647AC70-7210-462A-A43C-6EB4AFCB7ED4}.Release|x64.Build.0 = Release|Any CPU
 		{B647AC70-7210-462A-A43C-6EB4AFCB7ED4}.Release|x86.ActiveCfg = Release|Any CPU
 		{B647AC70-7210-462A-A43C-6EB4AFCB7ED4}.Release|x86.Build.0 = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|x64.Build.0 = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Debug|x86.Build.0 = Debug|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|x64.ActiveCfg = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|x64.Build.0 = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|x86.ActiveCfg = Release|Any CPU
+		{B94B9317-E255-4851-9110-0366906EA8A8}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -130,6 +144,7 @@ Global
 		{2C7C52E9-835F-4051-9A5E-7D985545A795} = {A5767C5D-9A48-4485-8D5E-686F34B2B766}
 		{25312E6A-4BA3-4FDF-AA7C-CF2A10CDA2AA} = {A5767C5D-9A48-4485-8D5E-686F34B2B766}
 		{B647AC70-7210-462A-A43C-6EB4AFCB7ED4} = {A5767C5D-9A48-4485-8D5E-686F34B2B766}
+		{B94B9317-E255-4851-9110-0366906EA8A8} = {4073E5F4-CD63-4DAA-864D-83A76827807E}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {4B2214E5-8A73-47CE-9C97-4910BC331A86}
diff --git a/build/Build.cs b/build/Build.cs
@@ -12,11 +12,9 @@
 using Nuke.Common.Tools.GitVersion;
 using Nuke.Common.Utilities.Collections;
 using static Nuke.Common.EnvironmentInfo;
-using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.IO.PathConstruction;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
 
-[CheckBuildProjectConfigurations]
 [ShutdownDotNetAfterServerBuild]
 class Build : NukeBuild
 {
@@ -49,9 +47,9 @@ class Build : NukeBuild
         .Before(Restore)
         .Executes(() =>
         {
-            SourceDirectory.GlobDirectories("**/bin", "**/obj").ForEach(DeleteDirectory);
-            TestsDirectory.GlobDirectories("**/bin", "**/obj").ForEach(DeleteDirectory);
-            EnsureCleanDirectory(OutputDirectory);
+            SourceDirectory.GlobDirectories("**/bin", "**/obj").DeleteDirectories();
+            TestsDirectory.GlobDirectories("**/bin", "**/obj").DeleteDirectories();
+            OutputDirectory.CreateOrCleanDirectory();
         });
 
     Target Restore => _ => _
diff --git a/build/_build.csproj b/build/_build.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net7.0</TargetFramework>
     <RootNamespace></RootNamespace>
     <NoWarn>CS0649;CS0169</NoWarn>
     <NukeRootDirectory>..</NukeRootDirectory>
@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Nuke.Common" Version="6.3.0" />
+    <PackageReference Include="Nuke.Common" Version="7.0.6" />
     <PackageDownload Include="GitVersion.Tool" Version="[5.8.1]" />
   </ItemGroup>
 
diff --git a/samples/MinimalApiSample/MinimalApiSample.csproj b/samples/MinimalApiSample/MinimalApiSample.csproj
@@ -7,10 +7,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.2.3" />
-	<ProjectReference Include="..\..\src\Intility.Extensions.Logging.Elasticsearch\Intility.Extensions.Logging.Elasticsearch.csproj" />
-	<ProjectReference Include="..\..\src\Intility.Extensions.Logging.Sentry\Intility.Extensions.Logging.Sentry.csproj" />
-	<ProjectReference Include="..\..\src\Intility.Logging.AspNetCore\Intility.Logging.AspNetCore.csproj" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Dynatrace\Intility.Extensions.Logging.Dynatrace.csproj" />
+	  <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Elasticsearch\Intility.Extensions.Logging.Elasticsearch.csproj" />
+	  <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Sentry\Intility.Extensions.Logging.Sentry.csproj" />
+	  <ProjectReference Include="..\..\src\Intility.Logging.AspNetCore\Intility.Logging.AspNetCore.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/samples/MinimalApiSample/Program.cs b/samples/MinimalApiSample/Program.cs
@@ -6,7 +6,8 @@
 {
     logging.UseDefaultEnrichers()
         .UseElasticsearch()
-        .UseSentry();
+        .UseSentry()
+        .UseDynatrace();
 });
 
 // Add services to the container.
diff --git a/samples/MinimalApiSample/appsettings.json b/samples/MinimalApiSample/appsettings.json
@@ -6,6 +6,14 @@
     }
   },
   "AllowedHosts": "*",
+  "Elasticsearch": {
+    "Endpoints": "localhost:9200",
+    "IndexFormat": "my-service-{0:yyyy.MM}"
+  },
+  "Dynatrace": {
+    "IngestUrl": "localhost:9200",
+    "AccessToken":  "test"
+  },
   "Sentry": {
     "Dsn": "https://examplePublicKey@o0.ingest.sentry.io/0",
     "MaxRequestBodySize": "Always",
diff --git a/samples/WebSample/Program.cs b/samples/WebSample/Program.cs
@@ -17,7 +17,8 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>
                 {
                     logging.UseDefaultEnrichers()
                         .UseElasticsearch()
-                        .UseSentry();
+                        .UseSentry()
+                        .UseDynatrace();
                 })
                 .ConfigureWebHostDefaults(webBuilder =>
                 {
diff --git a/samples/WebSample/WebSample.csproj b/samples/WebSample/WebSample.csproj
@@ -5,6 +5,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Dynatrace\Intility.Extensions.Logging.Dynatrace.csproj" />
     <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Elasticsearch\Intility.Extensions.Logging.Elasticsearch.csproj" />
     <ProjectReference Include="..\..\src\Intility.Extensions.Logging.Sentry\Intility.Extensions.Logging.Sentry.csproj" />
     <ProjectReference Include="..\..\src\Intility.Logging.AspNetCore\Intility.Logging.AspNetCore.csproj" />
diff --git a/samples/WebSample/appsettings.json b/samples/WebSample/appsettings.json
@@ -16,6 +16,10 @@
     "Endpoints": "localhost:9200",
     "IndexFormat": "my-service-{0:yyyy.MM}"
   },
+  "Dynatrace": {
+    "IngestUrl": "localhost:9200",
+    "AccessToken": "test"
+  },
   "Sentry": {
     "Dsn": "https://examplePublicKey@o0.ingest.sentry.io/0",
     "MaxRequestBodySize": "Always",
diff --git a/src/Intility.Extensions.Logging.Dynatrace/Intility.Extensions.Logging.Dynatrace.csproj b/src/Intility.Extensions.Logging.Dynatrace/Intility.Extensions.Logging.Dynatrace.csproj
@@ -0,0 +1,33 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <IsPackable>true</IsPackable>
+    <PackageId>Intility.Extensions.Logging.Dynatrace</PackageId>
+    <PackageTags>intility;logging;extensions;dynatrace</PackageTags>
+    <Description>
+      Enable Dynatrace logging provider.
+    </Description>
+    <owners>Intility</owners>
+    <Company>Intility</Company>
+    <authors>Herman Jensen, Emil Kjelsrud, Thorstein Løkensgard</authors>
+    <RepositoryUrl>https://github.com/Intility/Intility.Logging</RepositoryUrl>
+    <PackageIcon>intility-logo.png</PackageIcon>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Serilog.Sinks.Dynatrace" Version="1.0.7" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Intility.Extensions.Logging\Intility.Extensions.Logging.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="../../assets/intility-logo.png" Pack="true" Visible="false" PackagePath="\" />
+  </ItemGroup>
+
+</Project>
diff --git a/src/Intility.Extensions.Logging.Dynatrace/LoggerBuilderExtensions.cs b/src/Intility.Extensions.Logging.Dynatrace/LoggerBuilderExtensions.cs
@@ -0,0 +1,36 @@
+﻿using Serilog;
+using System;
+
+namespace Intility.Extensions.Logging
+{
+    public static class LoggerBuilderExtensions
+    {
+        /// <summary>
+        /// Uses Dynatrace sink if IngestUrl is defined in the <paramref name="configSection"/>.
+        /// </summary>
+        /// <param name="builder"></param>
+        /// <param name="configSection"></param>
+        /// <returns></returns>
+        public static ILoggerBuilder UseDynatrace(this ILoggerBuilder builder, string configSection = "Dynatrace")
+        {
+            var configuration = builder.Host.Configuration.GetSection(configSection);
+            var ingestUrl = configuration["IngestUrl"];
+            if (string.IsNullOrWhiteSpace(ingestUrl))
+            {
+                return builder;
+            }
+
+            var accessToken = configuration["AccessToken"];
+            if (string.IsNullOrWhiteSpace(accessToken))
+            {
+                throw new Exception("Failed to initialize Dynatrace sink", new ArgumentException("missing dynatrace config: " + configSection + ":AccessToken"));
+            }
+
+            var hostName = configuration["HostName"] ?? null;
+            var applicationId = configuration["ApplicationId"] ?? null;
+
+            builder.Configuration.WriteTo.Dynatrace(accessToken, ingestUrl, applicationId: applicationId, hostName: hostName);
+            return builder;
+        }
+    }
+}
diff --git a/src/Intility.Logging.AspNetCore/HostBuilderExtensions.cs b/src/Intility.Logging.AspNetCore/HostBuilderExtensions.cs
@@ -19,7 +19,14 @@ public static IHostBuilder UseIntilityLogging(this IHostBuilder builder, Action<
 
             builder.UseSerilog((HostBuilderContext ctx, LoggerConfiguration logger) =>
             {
+#if NET7_0_OR_GREATER
+                logger.ReadFrom.Configuration(ctx.Configuration, readerOptions: new()
+                {
+                    SectionName = "Serilog "
+                });
+#else
                 logger.ReadFrom.Configuration(ctx.Configuration, sectionName: "Serilog");
+#endif
 
                 var loggerBuilder = new LoggerBuilder(ctx, logger, builder);
                 configure?.Invoke(ctx, loggerBuilder);
diff --git a/src/Intility.Logging.AspNetCore/Intility.Logging.AspNetCore.csproj b/src/Intility.Logging.AspNetCore/Intility.Logging.AspNetCore.csproj
@@ -21,20 +21,21 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Serilog.AspNetCore" Version="6.1.0" />
 		<PackageReference Include="Serilog.Enrichers.AssemblyName" Version="1.0.9" />
-		<PackageReference Include="Serilog.Enrichers.Environment" Version="2.2.0" />
+		<PackageReference Include="Serilog.Enrichers.Environment" Version="2.3.0" />
 		<PackageReference Include="Serilog.Enrichers.Memory" Version="1.0.4" />
     <PackageReference Include="Serilog.Enrichers.AzureClaims" Version="1.0.1" />
-		<PackageReference Include="Serilog.Sinks.Elasticsearch" Version="9.0.0" />
+		<PackageReference Include="Serilog.Sinks.Elasticsearch" Version="9.0.3" />
 	</ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
+    <PackageReference Include="Serilog.AspNetCore" Version="6.1.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.4" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net7.0' ">
+    <PackageReference Include="Serilog.AspNetCore" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.1" />
   </ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-04/schema#",`
`3`		`- "title": "Build Schema",`
`4`	`3`	`"$ref": "#/definitions/build",`
	`4`	`+ "title": "Build Schema",`
`5`	`5`	`"definitions": {`
`6`	`6`	`"build": {`
`7`	`7`	`"type": "object",`
`@@ -119,4 +119,4 @@`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`	`}`
`122`		`-}`
	`122`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,8 @@`
`6`	`6`	`{`
`7`	`7`	`logging.UseDefaultEnrichers()`
`8`	`8`	`.UseElasticsearch()`
`9`		`- .UseSentry();`
	`9`	`+ .UseSentry()`
	`10`	`+ .UseDynatrace();`
`10`	`11`	`});`
`11`	`12`
`12`	`13`	`// Add services to the container.`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,8 @@ public static IHostBuilder CreateHostBuilder(string[] args) =>`
`17`	`17`	`{`
`18`	`18`	`logging.UseDefaultEnrichers()`
`19`	`19`	`.UseElasticsearch()`
`20`		`- .UseSentry();`
	`20`	`+ .UseSentry()`
	`21`	`+ .UseDynatrace();`
`21`	`22`	`})`
`22`	`23`	`.ConfigureWebHostDefaults(webBuilder =>`
`23`	`24`	`{`