trace context (#65)

* trace context * fix git-secrets * use opentelemetry version 1.3.1 * update
logzio · Jan 31, 2023 · 7a2eeb2 · 7a2eeb2
1 parent ad44aab
commit 7a2eeb2
Show file tree

Hide file tree

Showing 9 changed files with 113 additions and 16 deletions.
diff --git a/.github/workflows/git-secrets.yml b/.github/workflows/git-secrets.yml
@@ -1,33 +1,32 @@
 name: git-secrets
-
 # Controls when the workflow will run
 # Triggers the workflow on push or pull request events but only for the main branch
 on: [push]
-
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "main"
   git-secrets:
     # The type of runner that the job will run on
-    runs-on: ubuntu-18.04
-
+    runs-on: ubuntu-22.04
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: Check Out Source Code
-        uses: actions/checkout@v2
-
+        uses: actions/checkout@v3
       - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: 3.8
       - name: Installing dependencies
         run:
-          sudo apt-get install git less openssh-server
+          sudo apt-get install less openssh-server
       - name: Installing scanning tool
         run: |
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+          ln -s "$(which echo)" /usr/local/bin/say
           brew install git-secrets
           git secrets --install
           git secrets --register-aws 
       - name: Running scanning tool
         run:
+          eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
           git secrets --scan
diff --git a/docs/log4net.md b/docs/log4net.md
@@ -5,6 +5,7 @@
 	- [Code](#code)
 - [Custom Fields](#custom-fields)
 - [Extensibility](#extensibility)
+- [Trace Context](#trace-context)
 - [Code Samples](#code-samples)
 
 
@@ -55,6 +56,8 @@ If you configure your logging in an XML file, simply add a reference to the Logz
 	with capital letter in Logz.io, set this field to true. The default is false 
 	(first letter will be small letter). -->
 	<jsonKeysCamelCase>false</jsonKeysCamelCase>
+	<!-- Add trace context (traceId and spanId) to each log. The default is false -->
+	<addTraceContext>false</addTraceContext>
     </appender>
 
     <root>
@@ -79,8 +82,9 @@ logzioAppender.AddListenerUrl("<<LISTENER-HOST>>");
 // <-- Uncomment these lines to enable gzip compression --> 
 // logzioAppender.AddGzip(true);
 // logzioAppender.ActivateOptions();
-// logzioAppender.JsonKeysCamelCase(false)
-logzioAppender.ActiveOptions();
+// logzioAppender.JsonKeysCamelCase(false);
+// logzioAppender.AddTraceContext(false);
+logzioAppender.ActivateOptions();
 hierarchy.Root.AddAppender(logzioAppender);
 hierarchy.Root.Level = Level.All;
 hierarchy.Configured = true;
@@ -120,6 +124,15 @@ public class MyAppLogzioAppender : LogzioAppender
 
 You will then have to change your configuration in order to use your own appender.
 
+## Trace Context
+
+**WARNING**: Does not support .NET Standard 1.3
+
+If you’re sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context.
+In this way, your logs will have traces data in it: span id and trace id.
+To enable this feature, set `<addTraceContext>true</addTraceContext>` in your configuration or `logzioAppender.AddTraceContext(true);`
+in your code (as shown in the previews sections).
+
 ## Code Samples
 
 ### XML

diff --git a/docs/loggerFactory.md b/docs/loggerFactory.md
@@ -5,6 +5,7 @@
     - [Code](#code)
 - [Custom Fields](#custom-fields)
 - [Extensibility](#extensibility)
+- [Trace Context](#trace-context)
 - [Code Sample](#code-sample)
     - [ASP.NET Core](#aspnet-core)
     - [.NET Core Desktop Application](#net-core-desktop-application)
@@ -57,6 +58,8 @@ If you configure your logging in an XML file, simply add a reference to the Logz
 	<debug>false</debug>
         <!-- Set to true if you want json keys in Logz.io to be in camel case. The default is false. -->
         <jsonKeysCamelCase>false</jsonKeysCamelCase>
+        <!-- Add trace context (traceId and spanId) to each log. The default is false -->
+        <addTraceContext>false</addTraceContext>
     </appender>
 
     <root>
@@ -78,7 +81,8 @@ logzioAppender.AddListenerUrl("<<LISTENER-HOST>>");
 // Uncomment these lines to enable gzip compression 
 // logzioAppender.AddGzip(true);
 // logzioAppender.ActivateOptions();
-// logzioAppender.JsonKeysCamelCase(false)
+// logzioAppender.JsonKeysCamelCase(false);
+// logzioAppender.AddTraceContext(false);
 logzioAppender.ActiveOptions();
 hierarchy.Root.AddAppender(logzioAppender);
 hierarchy.Root.Level = Level.All;
@@ -119,6 +123,15 @@ public class MyAppLogzioAppender : LogzioAppender
 
 You will then have to change your configuration in order to use your own appender.
 
+## Trace Context
+
+**WARNING**: Does not support .NET Standard 1.3
+
+If you’re sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context.
+In this way, your logs will have traces data in it: span id and trace id.
+To enable this feature, set `<addTraceContext>true</addTraceContext>` in your configuration or `logzioAppender.AddTraceContext(true);`
+in your code (as shown in the previews sections).
+
 ## Code Sample
 
 ### ASP.NET Core

diff --git a/docs/nlog.md b/docs/nlog.md
@@ -5,6 +5,7 @@
 	- [Code](#code)
 - [Variables](#variables)
 - [Extensibility](#extensibility)
+- [Trace Context](#trace-context)
 
 
 Install the NLog target from the Package Manager Console:
@@ -41,6 +42,7 @@ If you configure your logging in an XML file, you need to register the assembly
 		useGzip="false"
 		debug="false"
 		jsonKeysCamelCase="false"
+		addTraceContext="false"
 		<!-- parseJsonMessage="true"-->
 	>
 		<contextproperty name="host" layout="${machinename}" />
@@ -71,6 +73,7 @@ var logzioTarget = new LogzioTarget {
     RetriesInterval = TimeSpan.Parse("00:00:02"),
     Debug = false,
     JsonKeysCamelCase = false,
+    AddTraceContext = false,
     // ParseJsonMessage = true, 
     // ProxyAddress = "http://your.proxy.com:port"
 };
@@ -91,7 +94,6 @@ for example:
 ````
 Click here for more information about [JsonLayout](https://github.com/NLog/NLog/wiki/JsonLayout).
 
-
 ## Context Properties
 
 You can configure the target to include your own custom values when forwarding to Logzio. For example:
@@ -129,3 +131,12 @@ public class MyAppLogzioTarget : LogzioTarget
 ```
 
 You will then have to change your configuration in order to use your own target.
+
+## Trace Context
+
+**WARNING**: Does not support .NET Standard 1.3
+
+If you’re sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context.
+In this way, your logs will have traces data in it: span id and trace id.
+To enable this feature, set `addTraceContext="true"` in your configuration or `AddTraceContext = true`
+in your code (as shown in the previews sections).
diff --git a/src/Core/Shipping/BulkSenderOptions.cs b/src/Core/Shipping/BulkSenderOptions.cs
@@ -14,5 +14,6 @@ public class BulkSenderOptions
         public string ProxyAddress { get; set; } = String.Empty;
         public bool ParseJsonMessage { get; set; } = false;
         public bool JsonKeysCamelCase { get; set; } = false;
+        public bool AddTraceContext { get; set; } = false;
     }
 }
diff --git a/src/Log4netShipper/Log4netShipper.csproj b/src/Log4netShipper/Log4netShipper.csproj
@@ -6,15 +6,15 @@
 
     <Description>log4net appender that sends logs to the logz.io bulk HTTP service</Description>
     <Company>Logz.io</Company>
-    <Authors>Maor Rosenfeld</Authors>
+    <Authors>Maor Rosenfeld;Shiran Avidov</Authors>
     <CurrentYear>$([System.DateTime]::Now.ToString(yyyy))</CurrentYear>
     <Copyright>Copyright (c) $(CurrentYear) - Logz.io</Copyright>
     <PackageTags>logging;log;logzio;log4net</PackageTags>
     <PackageProjectUrl>https://github.com/logzio/logzio-dotnet</PackageProjectUrl>
     <PackageLicenseUrl>https://www.apache.org/licenses/LICENSE-2.0</PackageLicenseUrl>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>git://github.com/logzio/logzio-dotnet</RepositoryUrl>
-    <PackageVersion>1.0.13</PackageVersion>
+    <PackageVersion>1.0.14</PackageVersion>
     <PackageReleaseNotes>Option to format message as json</PackageReleaseNotes>
   </PropertyGroup>
 
@@ -28,6 +28,18 @@
     <ProjectReference Include="..\Core\Core.csproj" PrivateAssets="all" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
   <PropertyGroup>
     <TargetsForTfmSpecificBuildOutput>
       $(TargetsForTfmSpecificBuildOutput);PackReferencedProjectOutputs

diff --git a/src/Log4netShipper/LogzioAppender.cs b/src/Log4netShipper/LogzioAppender.cs
@@ -8,6 +8,10 @@
 using Logzio.DotNet.Core.Shipping;
 using Newtonsoft.Json.Linq;
 
+#if !NETSTANDARD1_3
+using OpenTelemetry.Trace;
+#endif
+
 namespace Logzio.DotNet.Log4net
 {
     public class LogzioAppender : AppenderSkeleton
@@ -78,6 +82,17 @@ private void WriteImpl(LoggingEvent loggingEvent)
                     }
                 }
 
+#if !NETSTANDARD1_3
+                if (_shipperOptions.BulkSenderOptions.AddTraceContext)
+                {
+                    var traceId = Tracer.CurrentSpan.Context.TraceId;
+                    var spanId = Tracer.CurrentSpan.Context.SpanId;
+
+                    values.Add("traceId", traceId.ToString());
+                    values.Add("spanId", spanId.ToString());
+                }
+#endif
+
                 foreach (var customField in _customFields)
                 {
                     values[customField.Key] = customField.Value;
@@ -163,6 +178,11 @@ public void JsonKeysCamelCase(bool value)
             _shipperOptions.BulkSenderOptions.JsonKeysCamelCase = value;
         }
 
+        public void AddTraceContext(bool value)
+        {
+            _shipperOptions.BulkSenderOptions.AddTraceContext = value;
+        }
+
         public void AddBufferTimeout(TimeSpan value)
         {
             _shipperOptions.BufferTimeLimit = value;

diff --git a/src/NLogShipper/LogzioTarget.cs b/src/NLogShipper/LogzioTarget.cs
@@ -8,6 +8,10 @@
 using NLog.Config;
 using NLog.Targets;
 
+#if !NETSTANDARD1_3
+using OpenTelemetry.Trace;
+#endif
+
 namespace Logzio.DotNet.NLog
 {
     [Target("Logzio")]
@@ -33,6 +37,7 @@ public class LogzioTarget : TargetWithContext
 
         public bool ParseJsonMessage { get { return _shipperOptions.BulkSenderOptions.ParseJsonMessage; } set { _shipperOptions.BulkSenderOptions.ParseJsonMessage = value; } }
         public bool JsonKeysCamelCase { get { return _shipperOptions.BulkSenderOptions.JsonKeysCamelCase; } set { _shipperOptions.BulkSenderOptions.JsonKeysCamelCase = value; } }
+        public bool AddTraceContext { get { return _shipperOptions.BulkSenderOptions.AddTraceContext; } set { _shipperOptions.BulkSenderOptions.AddTraceContext = value; } }
 
         /// <summary>
         /// Configuration of additional properties to include with each LogEvent (Ex. ${logger}, ${machinename}, ${threadid} etc.)
@@ -135,6 +140,17 @@ protected override void Write(LogEventInfo logEvent)
                         }
                     }
                 }
+
+#if !NETSTANDARD1_3
+                if (AddTraceContext)
+                {
+                    var traceId = Tracer.CurrentSpan.Context.TraceId;
+                    var spanId = Tracer.CurrentSpan.Context.SpanId;
+
+                    values.Add("traceId", traceId.ToString());
+                    values.Add("spanId", spanId.ToString());
+                }
+#endif
 
                 ExtendValues(logEvent, values);
 

diff --git a/src/NLogShipper/NLogShipper.csproj b/src/NLogShipper/NLogShipper.csproj
@@ -6,15 +6,15 @@
 
     <Description>NLog target that sends logs to the logz.io bulk HTTP service</Description>
     <Company>Logz.io</Company>
-    <Authors>Maor Rosenfeld</Authors>
+    <Authors>Maor Rosenfeld;Shiran Avidov</Authors>
     <CurrentYear>$([System.DateTime]::Now.ToString(yyyy))</CurrentYear>
     <Copyright>Copyright (c) $(CurrentYear) - Logz.io</Copyright>
     <PackageTags>logging;log;logzio;nlog</PackageTags>
     <PackageProjectUrl>https://github.com/logzio/logzio-dotnet</PackageProjectUrl>
     <PackageLicenseUrl>https://www.apache.org/licenses/LICENSE-2.0</PackageLicenseUrl>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>git://github.com/logzio/logzio-dotnet</RepositoryUrl>
-    <PackageVersion>1.0.13</PackageVersion>
+    <PackageVersion>1.0.14</PackageVersion>
     <PackageReleaseNotes>Option to format message as json</PackageReleaseNotes>
   </PropertyGroup>
 
@@ -28,6 +28,18 @@
     <ProjectReference Include="..\Core\Core.csproj" PrivateAssets="all" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
+    <PackageReference Include="OpenTelemetry" Version="1.3.1" />
+  </ItemGroup>
+
   <PropertyGroup>
     <TargetsForTfmSpecificBuildOutput>
       $(TargetsForTfmSpecificBuildOutput);PackReferencedProjectOutputs