Logging improvements

LICENSE-3rdparty.csv

@@ -1,7 +1,7 @@
 Component,Origin,License,Copyright
-Datadog.Trace,https://github.com/serilog/serilog,Apache-2.0,Copyright (c) 2013-2018 Serilog Contributors
-Datadog.Trace,https://github.com/serilog/serilog-sinks-file,Apache-2.0,Copyright (c) 2016 Serilog Contributors
-Datadog.Trace,https://github.com/JamesNK/Newtonsoft.Json,MIT,Copyright (c) 2007 James Newton-King
+OpenTelemetry.AutoInstrumentation,https://github.com/serilog/serilog,Apache-2.0,Copyright (c) 2013-2018 Serilog Contributors
+OpenTelemetry.AutoInstrumentation,https://github.com/serilog/serilog-sinks-file,Apache-2.0,Copyright (c) 2016 Serilog Contributors
+OpenTelemetry.AutoInstrumentation,https://github.com/JamesNK/Newtonsoft.Json,MIT,Copyright (c) 2007 James Newton-King
 OpenTelemetry.AutoInstrumentation.Native,https://github.com/dotnet/runtime,MIT,Copyright (c) .NET Foundation and contributors. All rights reserved.
 OpenTelemetry.AutoInstrumentation.Native,https://github.com/Microsoft/clr-samples,MIT,Copyright (c) .NET Foundation and contributors. All rights reserved.
 OpenTelemetry.AutoInstrumentation.Native,https://github.com/MicrosoftArchive/clrprofiler,MIT,Copyright (c) Microsoft Corporation.  All rights reserved.

src/OpenTelemetry.AutoInstrumentation.Loader/FileSink.cs

@@ -3,6 +3,20 @@
 // This comment is here to prevent StyleCop from analyzing a file originally from Serilog.
 //------------------------------------------------------------------------------
 
+// Copyright 2013-2019 Serilog Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 using System;
 using System.IO;
 using System.Text;

src/OpenTelemetry.AutoInstrumentation.Loader/StartupLogger.cs

@@ -144,7 +144,7 @@ private static string SetStartupLogFilePath()
 
         try
         {
-            var process = Process.GetCurrentProcess();
+            using var process = Process.GetCurrentProcess();
             // Do our best to not block other processes on write
             return Path.Combine(LogDirectory, $"dotnet-tracer-loader-{process.ProcessName}-{process.Id}.log");
         }

src/OpenTelemetry.AutoInstrumentation/CallTarget/Handlers/IntegrationMapper.cs

@@ -31,7 +31,7 @@ internal class IntegrationMapper
     private const string EndMethodName = "OnMethodEnd";
     private const string EndAsyncMethodName = "OnAsyncMethodEnd";
 
-    private static readonly ILogger Log = ConsoleLogger.Create(typeof(IntegrationMapper));
+    private static readonly ILogger Log = OtelLogging.GetLogger();
     private static readonly MethodInfo UnwrapReturnValueMethodInfo = typeof(IntegrationMapper).GetMethod(nameof(IntegrationMapper.UnwrapReturnValue), BindingFlags.NonPublic | BindingFlags.Static);
     private static readonly MethodInfo ConvertTypeMethodInfo = typeof(IntegrationMapper).GetMethod(nameof(IntegrationMapper.ConvertType), BindingFlags.NonPublic | BindingFlags.Static);
 

src/OpenTelemetry.AutoInstrumentation/CallTarget/Handlers/IntegrationOptions.cs

@@ -23,7 +23,7 @@ namespace OpenTelemetry.AutoInstrumentation.CallTarget.Handlers;
 
 internal static class IntegrationOptions<TIntegration, TTarget>
 {
-    private static readonly ILogger Log = ConsoleLogger.Create(typeof(IntegrationOptions<TIntegration, TTarget>));
+    private static readonly ILogger Log = OtelLogging.GetLogger();
 
     private static volatile bool _disableIntegration = false;
 

src/OpenTelemetry.AutoInstrumentation/Configuration/ConfigurationKeys.cs

@@ -84,6 +84,21 @@ public class ConfigurationKeys
     /// </summary>
     public const string Http2UnencryptedSupportEnabled = "OTEL_DOTNET_AUTO_HTTP2UNENCRYPTEDSUPPORT_ENABLED";
 
+    /// <summary>
+    /// Configuration key for setting the directory for the profiler's log files.
+    /// If set, this setting takes precedence over environment variable OTEL_DOTNET_AUTO_LOG_PATH.
+    /// If not set, default is
+    /// "%ProgramData%"\OpenTelemetry .NET AutoInstrumentation\logs\" on Windows or
+    /// "/var/log/opentelemetry/dotnet/" on Linux.
+    /// </summary>
+    public const string LogDirectory = "OTEL_DOTNET_AUTO_LOG_DIRECTORY";
+
+    /// <summary>
+    /// Configuration key for setting the path for the profiler's native log file.
+    /// Environment variable OTEL_DOTNET_AUTO_LOG_DIRECTORY takes precedence over this setting, if set.
+    /// </summary>
+    public const string LogPath = "OTEL_DOTNET_AUTO_LOG_PATH";
+
     /// <summary>
     /// String format patterns used to match integration-specific configuration keys.
     /// </summary>

src/OpenTelemetry.AutoInstrumentation/DuckTyping/DuckTypeExtensions.cs

@@ -16,7 +16,6 @@
 
 using System;
 using System.Runtime.CompilerServices;
-using OpenTelemetry.AutoInstrumentation.Logging;
 
 namespace OpenTelemetry.AutoInstrumentation.DuckTyping;
 
@@ -25,8 +24,6 @@ namespace OpenTelemetry.AutoInstrumentation.DuckTyping;
 /// </summary>
 public static class DuckTypeExtensions
 {
-    private static readonly ILogger Log = ConsoleLogger.Create(typeof(DuckType));
-
     /// <summary>
     /// Gets the duck type instance for the object implementing a base class or interface T
     /// </summary>

src/OpenTelemetry.AutoInstrumentation/FrameworkDescription.cs

@@ -22,7 +22,7 @@ namespace OpenTelemetry.AutoInstrumentation;
 
 internal partial class FrameworkDescription
 {
-    private static readonly ILogger Log = ConsoleLogger.Create(typeof(FrameworkDescription));
+    private static readonly ILogger Log = OtelLogging.GetLogger();
 
     private static readonly Assembly RootAssembly = typeof(object).Assembly;
 

src/OpenTelemetry.AutoInstrumentation/Instrumentation.cs

@@ -15,12 +15,13 @@
 // </copyright>
 
 using System;
-using System.Diagnostics;
 using System.Threading;
 using OpenTelemetry.AutoInstrumentation.Configuration;
+using OpenTelemetry.AutoInstrumentation.Logging;
 using OpenTelemetry.Context.Propagation;
 using OpenTelemetry.Shims.OpenTracing;
 using OpenTelemetry.Trace;
+using OpenTracing.Util;
 
 namespace OpenTelemetry.AutoInstrumentation;
 
@@ -29,7 +30,8 @@ namespace OpenTelemetry.AutoInstrumentation;
 /// </summary>
 public static class Instrumentation
 {
-    private static readonly Process _process = Process.GetCurrentProcess();
+    private static readonly ILogger Logger = OtelLogging.GetLogger();
+
     private static int _firstInitialization = 1;
     private static int _isExiting = 0;
 
@@ -81,7 +83,7 @@ public static void Initialize()
                     .InvokePlugins(TracerSettings.TracerPlugins);
 
                 _tracerProvider = builder.Build();
-                Log("OpenTelemetry tracer initialized.");
+                Logger.Information("OpenTelemetry tracer initialized.");
 
                 // Register to shutdown events
                 AppDomain.CurrentDomain.ProcessExit += OnExit;
@@ -91,7 +93,7 @@ public static void Initialize()
         }
         catch (Exception ex)
         {
-            Log($"OpenTelemetry SDK load exception: {ex}");
+            Logger.Error(ex, "OpenTelemetry SDK load exception.");
             throw;
         }
 
@@ -107,17 +109,17 @@ public static void Initialize()
 
                 // This registration must occur prior to any reference to the OpenTracing tracer:
                 // otherwise the no-op tracer is going to be used by OpenTracing instead.
-                OpenTracing.Util.GlobalTracer.RegisterIfAbsent(openTracingShim);
-                Log("OpenTracingShim loaded.");
+                GlobalTracer.RegisterIfAbsent(openTracingShim);
+                Logger.Information("OpenTracingShim loaded.");
             }
             else
             {
-                Log("OpenTracingShim was not loaded as the provider is not initialized.");
+                Logger.Information("OpenTracingShim was not loaded as the provider is not initialized.");
             }
         }
         catch (Exception ex)
         {
-            Log($"OpenTracingShim exception: {ex}");
+            Logger.Error(ex, "OpenTracingShim exception.");
             throw;
         }
     }
@@ -134,13 +136,13 @@ private static void OnExit(object sender, EventArgs e)
         {
             _tracerProvider.Dispose();
 
-            Log("OpenTelemetry tracer exit.");
+            Logger.Information("OpenTelemetry tracer exit.");
         }
         catch (Exception ex)
         {
             try
             {
-                Log($"An error occured while attempting to exit. {ex}");
+                Logger.Error(ex, "An error occured while attempting to exit.");
             }
             catch
             {
@@ -156,15 +158,15 @@ private static void OnUnhandledException(object sender, UnhandledExceptionEventA
         {
             if (args.IsTerminating)
             {
-                Log("UnhandledException event raised with a terminating exception.");
+                Logger.Error("UnhandledException event raised with a terminating exception.");
                 OnExit(sender, args);
             }
         }
         catch (Exception ex)
         {
             try
             {
-                Log($"An exception occured while processing an unhandled exception. {ex}");
+                Logger.Error(ex, "An exception occured while processing an unhandled exception.");
             }
             catch
             {
@@ -173,9 +175,4 @@ private static void OnUnhandledException(object sender, UnhandledExceptionEventA
             }
         }
     }
-
-    private static void Log(string message)
-    {
-        Console.WriteLine($">>>>>>>>>>>>>>>>>>>>>>> Process: {_process.ProcessName}({_process.Id}): {message}");
-    }
 }

src/OpenTelemetry.AutoInstrumentation/Instrumentations/GraphQL/GraphQLCommon.cs

@@ -43,7 +43,7 @@ internal class GraphQLCommon
     internal static readonly ActivitySource ActivitySource = new ActivitySource(
         "OpenTelemetry.AutoInstrumentation.GraphQL", "0.0.1");
 
-    private static readonly ILogger Log = ConsoleLogger.Create(typeof(GraphQLCommon));
+    private static readonly ILogger Log = OtelLogging.GetLogger();
 
     internal static Activity CreateActivityFromValidate(IDocument document)
     {

src/OpenTelemetry.AutoInstrumentation/Instrumentations/MongoDb/MongoDbIntegration.cs

@@ -40,7 +40,7 @@ public static class MongoDbIntegration
 
         private const string OperationName = "mongodb.query";
 
-        private static readonly ILogger Log = ConsoleLogger.Create(typeof(MongoDbIntegration));
+        private static readonly ILogger Log = OtelLogging.GetLogger();
 
         private static readonly ActivitySource ActivitySource = new ActivitySource(
             "OpenTelemetry.AutoInstrumentation.MongoDB", "0.0.1");

src/OpenTelemetry.AutoInstrumentation/Logging/FileSink.cs

@@ -0,0 +1,78 @@
+//------------------------------------------------------------------------------
+// <auto-generated />
+// This comment is here to prevent StyleCop from analyzing a file originally from Serilog.
+//------------------------------------------------------------------------------
+
+// Copyright 2013-2019 Serilog Contributors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.IO;
+using System.Text;
+using OpenTelemetry.AutoInstrumentation.Logging;
+
+namespace OpenTelemetry.AutoInstrumentation.Logging
+{
+    internal sealed class FileSink : ISink, IDisposable
+    {
+        readonly TextWriter _output;
+        readonly FileStream _underlyingStream;
+        readonly WriteCountingStream _countingStreamWrapper;
+        readonly object _syncRoot = new object();
+        static readonly long FileSizeLimitBytes = 10 * 1024 * 1024;
+
+        public FileSink(string path, Encoding encoding = null)
+        {
+            if (path == null) throw new ArgumentNullException(nameof(path));
+
+            var directory = Path.GetDirectoryName(path);
+            if (!string.IsNullOrWhiteSpace(directory) && !Directory.Exists(directory))
+            {
+                Directory.CreateDirectory(directory);
+            }
+
+            _underlyingStream = System.IO.File.Open(path, FileMode.Append, FileAccess.Write, FileShare.Read);
+
+            Stream outputStream = _countingStreamWrapper = new WriteCountingStream(_underlyingStream);
+            _output = new StreamWriter(outputStream, encoding ?? new UTF8Encoding(encoderShouldEmitUTF8Identifier: false));
+        }
+
+        public void Write(string message)
+        {
+            lock (_syncRoot)
+            {
+                if (_countingStreamWrapper.CountedLength >= FileSizeLimitBytes)
+                {
+                    return;
+                }
+                _output.Write(message);
+                FlushToDisk();
+            }
+        }
+
+        public void Dispose()
+        {
+            lock (_syncRoot)
+            {
+                _output.Dispose();
+            }
+        }
+
+        private void FlushToDisk()
+        {
+            _output.Flush();
+            _underlyingStream.Flush(true);
+        }
+    }
+}

src/OpenTelemetry.AutoInstrumentation/Logging/ISink.cs

@@ -0,0 +1,22 @@
+// <copyright file="ISink.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+namespace OpenTelemetry.AutoInstrumentation.Logging;
+
+internal interface ISink
+{
+    public void Write(string message);
+}

src/OpenTelemetry.AutoInstrumentation/Logging/ConsoleLogger.cs → src/OpenTelemetry.AutoInstrumentation/Logging/Logger.cs

@@ -1,4 +1,4 @@
-// <copyright file="ConsoleLogger.cs" company="OpenTelemetry Authors">
+// <copyright file="Logger.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,25 +19,14 @@
 
 namespace OpenTelemetry.AutoInstrumentation.Logging;
 
-internal class ConsoleLogger : ILogger
+internal class Logger : ILogger
 {
     private static readonly object[] NoPropertyValues = Array.Empty<object>();
+    private readonly ISink _sink;
 
-    private readonly string _name;
-
-    public ConsoleLogger(string name)
-    {
-        _name = name;
-    }
-
-    public static ConsoleLogger Create<T>()
+    internal Logger(ISink sink)
     {
-        return Create(typeof(T));
-    }
-
-    public static ConsoleLogger Create(Type type)
-    {
-        return new ConsoleLogger(type.Name);
+        _sink = sink ?? throw new ArgumentNullException(nameof(sink));
     }
 
     public bool IsEnabled(LogLevel level)
@@ -206,11 +195,14 @@ private void WriteImpl(LogLevel level, Exception exception, string messageTempla
     {
         try
         {
-            Console.WriteLine($"[{_name}] {level}:{string.Format(messageTemplate, args)}");
+            var message =
+                $"[{DateTime.UtcNow}] [{level}] {messageTemplate} {Environment.NewLine}";
+            _sink.Write(message);
 
             if (exception != null)
             {
-                Console.WriteLine($">> Exception: {exception.Message} {Environment.NewLine} {exception}");
+                var exceptionMessage = $"Exception: {exception.Message}{Environment.NewLine}{exception}{Environment.NewLine}";
+                _sink.Write(exceptionMessage);
             }
         }
         catch
@@ -221,7 +213,6 @@ private void WriteImpl(LogLevel level, Exception exception, string messageTempla
                 var properties = args.Length == 0
                     ? string.Empty
                     : "; " + string.Join(", ", args);
-
                 Console.Error.WriteLine($"{messageTemplate}{properties}{ex}");
             }
             catch