Add NLog instrumentation for OpenTelemetry .NET Auto-Instrumentation #4371
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| #nullable enable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #nullable enable | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Endpoint.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Endpoint.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Headers.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Headers.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeEventParameters.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeEventParameters.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeFormattedMessage.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeFormattedMessage.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxExportBatchSize.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxExportBatchSize.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxQueueSize.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxQueueSize.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.OpenTelemetryTarget() -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Resources.get -> System.Collections.Generic.IList<NLog.Targets.TargetPropertyWithContext!>! | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ScheduledDelayMilliseconds.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ScheduledDelayMilliseconds.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ServiceName.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ServiceName.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.SpanIdLayout.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.SpanIdLayout.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.TraceIdLayout.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.TraceIdLayout.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.UseHttp.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.UseHttp.set -> void |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| #nullable enable |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #nullable enable | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Endpoint.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Endpoint.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Headers.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Headers.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeEventParameters.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeEventParameters.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeFormattedMessage.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.IncludeFormattedMessage.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxExportBatchSize.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxExportBatchSize.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxQueueSize.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.MaxQueueSize.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.OpenTelemetryTarget() -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.Resources.get -> System.Collections.Generic.IList<NLog.Targets.TargetPropertyWithContext!>! | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ScheduledDelayMilliseconds.get -> int | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ScheduledDelayMilliseconds.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ServiceName.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.ServiceName.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.SpanIdLayout.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.SpanIdLayout.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.TraceIdLayout.get -> NLog.Layouts.Layout? | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.TraceIdLayout.set -> void | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.UseHttp.get -> bool | ||
| OpenTelemetry.AutoInstrumentation.NLogTarget.OpenTelemetryTarget.UseHttp.set -> void |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>$(TargetFrameworks)</TargetFrameworks> | ||
| <GenerateDocumentationFile>false</GenerateDocumentationFile> | ||
| <IsPackable>true</IsPackable> | ||
| <Description>OpenTelemetry NLog target that forwards NLog LogEvents to OpenTelemetry Logs.</Description> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\OpenTelemetry.AutoInstrumentation\OpenTelemetry.AutoInstrumentation.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="NLog" /> | ||
| </ItemGroup> | ||
| </Project> | ||
|
|
zacharycmontoya marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System; | ||
| using System.Collections.Concurrent; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
| using NLog; | ||
| using NLog.Config; | ||
| using NLog.Layouts; | ||
| using NLog.Targets; | ||
| using OpenTelemetry; | ||
| using OpenTelemetry.AutoInstrumentation; | ||
| using OpenTelemetry.AutoInstrumentation.Configurations; | ||
| using OpenTelemetry.Logs; | ||
|
|
||
| namespace OpenTelemetry.AutoInstrumentation.NLogTarget; | ||
|
|
||
| [Target("OpenTelemetryTarget")] | ||
| public sealed class OpenTelemetryTarget : TargetWithContext | ||
| { | ||
| private static readonly ConcurrentDictionary<string, object> LoggerCache = new(StringComparer.Ordinal); | ||
| private static readonly string EmptyTraceIdToHexString = default(ActivityTraceId).ToHexString(); | ||
| private static readonly string EmptySpanIdToHexString = default(ActivitySpanId).ToHexString(); | ||
| private static LoggerProvider? _loggerProvider; | ||
| private static Func<string?, object?>? _getLoggerFactory; | ||
|
|
||
| public OpenTelemetryTarget() | ||
| { | ||
| Layout = "${message}"; | ||
| TraceIdLayout = "${activity:property=TraceId}"; | ||
| SpanIdLayout = "${activity:property=SpanId}"; | ||
| } | ||
|
|
||
| [RequiredParameter] | ||
| public Layout? Endpoint { get; set; } | ||
|
|
||
| public Layout? Headers { get; set; } | ||
|
|
||
| public bool UseHttp { get; set; } = true; | ||
|
|
||
| public Layout? ServiceName { get; set; } | ||
|
|
||
| [ArrayParameter(typeof(TargetPropertyWithContext), "resource")] | ||
| public IList<TargetPropertyWithContext> Resources { get; } = new List<TargetPropertyWithContext>(); | ||
|
|
||
| public bool IncludeFormattedMessage { get; set; } = true; | ||
|
|
||
| public bool IncludeEventParameters { get; set; } = true; | ||
|
|
||
| public Layout? TraceIdLayout { get; set; } | ||
|
|
||
| public Layout? SpanIdLayout { get; set; } | ||
|
|
||
| public int ScheduledDelayMilliseconds { get; set; } = 5000; | ||
|
|
||
| public int MaxQueueSize { get; set; } = 2048; | ||
|
|
||
| public int MaxExportBatchSize { get; set; } = 512; | ||
|
|
||
| protected override void InitializeTarget() | ||
| { | ||
| base.InitializeTarget(); | ||
|
|
||
| if (_loggerProvider != null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var createLoggerProviderBuilderMethod = typeof(Sdk).GetMethod("CreateLoggerProviderBuilder", System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.NonPublic)!; | ||
| var loggerProviderBuilder = (LoggerProviderBuilder)createLoggerProviderBuilderMethod.Invoke(null, null)!; | ||
|
|
||
| loggerProviderBuilder = loggerProviderBuilder | ||
| .SetResourceBuilder(ResourceConfigurator.CreateResourceBuilder(Instrumentation.GeneralSettings.Value.EnabledResourceDetectors)); | ||
|
|
||
| loggerProviderBuilder = loggerProviderBuilder.AddOtlpExporter(options => | ||
| { | ||
| var endpoint = RenderLogEvent(Endpoint, LogEventInfo.CreateNullEvent()); | ||
zacharycmontoya marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if (string.IsNullOrEmpty(endpoint)) | ||
| { | ||
| endpoint = Environment.GetEnvironmentVariable("OTEL_EXPORTER_OTLP_ENDPOINT"); | ||
| } | ||
|
|
||
| if (!string.IsNullOrEmpty(endpoint)) | ||
| { | ||
| options.Endpoint = new Uri(endpoint!, UriKind.RelativeOrAbsolute); | ||
| } | ||
|
|
||
| var headers = RenderLogEvent(Headers, LogEventInfo.CreateNullEvent()); | ||
| if (!string.IsNullOrEmpty(headers)) | ||
| { | ||
| options.Headers = headers; | ||
| } | ||
|
|
||
| options.Protocol = UseHttp ? OpenTelemetry.Exporter.OtlpExportProtocol.HttpProtobuf : OpenTelemetry.Exporter.OtlpExportProtocol.Grpc; | ||
| options.BatchExportProcessorOptions.ScheduledDelayMilliseconds = ScheduledDelayMilliseconds; | ||
| options.BatchExportProcessorOptions.MaxQueueSize = MaxQueueSize; | ||
| options.BatchExportProcessorOptions.MaxExportBatchSize = MaxExportBatchSize; | ||
| }); | ||
|
|
||
| _loggerProvider = loggerProviderBuilder.Build(); | ||
| _getLoggerFactory = CreateGetLoggerDelegate(_loggerProvider); | ||
| } | ||
|
|
||
| protected override void Write(LogEventInfo logEvent) | ||
| { | ||
| if (_loggerProvider is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| if (Sdk.SuppressInstrumentation) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var logger = GetOrCreateLogger(logEvent.LoggerName); | ||
| if (logger is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var properties = GetLogEventProperties(logEvent); | ||
|
|
||
| var body = IncludeFormattedMessage ? RenderLogEvent(Layout, logEvent) : Convert.ToString(logEvent.Message); | ||
|
|
||
| var severityText = logEvent.Level.Name; | ||
| var severityNumber = MapLogLevelToSeverity(logEvent.Level); | ||
|
|
||
| // Resolve trace context using Layout properties (works with AsyncWrapper) | ||
| Activity? current = null; | ||
| var traceIdString = RenderLogEvent(TraceIdLayout, logEvent); | ||
| var spanIdString = RenderLogEvent(SpanIdLayout, logEvent); | ||
|
|
||
| if (!string.IsNullOrEmpty(traceIdString) && !string.IsNullOrEmpty(spanIdString) && | ||
| traceIdString != EmptyTraceIdToHexString && spanIdString != EmptySpanIdToHexString) | ||
| { | ||
| try | ||
| { | ||
| var traceId = ActivityTraceId.CreateFromString(traceIdString); | ||
| var spanId = ActivitySpanId.CreateFromString(spanIdString); | ||
| var activityContext = new ActivityContext(traceId, spanId, ActivityTraceFlags.Recorded); | ||
|
||
| current = new Activity("OpenTelemetryTarget").SetParentId(activityContext.TraceId, activityContext.SpanId, activityContext.TraceFlags); | ||
| } | ||
| catch | ||
| { | ||
| // If parsing fails, fall back to Activity.Current | ||
| current = Activity.Current; | ||
| } | ||
| } | ||
| else | ||
| { | ||
| current = Activity.Current; | ||
| } | ||
|
|
||
| // Emit using internal helpers via reflection delegate | ||
| var renderedMessage = IncludeFormattedMessage ? RenderLogEvent(Layout, logEvent) : logEvent.Message; | ||
| var args = IncludeEventParameters && !logEvent.HasProperties && logEvent.Parameters is object[] p ? p : null; | ||
|
|
||
| OpenTelemetry.AutoInstrumentation.Instrumentations.NLog.Bridge.OpenTelemetryLogHelpers.LogEmitter?.Invoke( | ||
| logger, | ||
| body, | ||
| logEvent.TimeStamp, | ||
| severityText, | ||
| severityNumber, | ||
| logEvent.Exception, | ||
| properties, | ||
| current, | ||
| args, | ||
| renderedMessage); | ||
| } | ||
|
|
||
| private static int MapLogLevelToSeverity(LogLevel level) | ||
| { | ||
| // Map NLog ordinals 0..5 to OTEL severity 1..24 approximate buckets | ||
| return level.Ordinal switch | ||
| { | ||
| 0 => 1, // Trace | ||
| 1 => 5, // Debug | ||
| 2 => 9, // Info | ||
| 3 => 13, // Warn | ||
| 4 => 17, // Error | ||
| 5 => 21, // Fatal | ||
| _ => 9 | ||
| }; | ||
| } | ||
|
|
||
| private static Func<string?, object?>? CreateGetLoggerDelegate(LoggerProvider loggerProvider) | ||
| { | ||
| try | ||
| { | ||
| var methodInfo = typeof(LoggerProvider) | ||
| .GetMethod("GetLogger", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance, null, new[] { typeof(string) }, null)!; | ||
| return (Func<string?, object?>)methodInfo.CreateDelegate(typeof(Func<string?, object?>), loggerProvider); | ||
| } | ||
| catch | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private object? GetOrCreateLogger(string? loggerName) | ||
| { | ||
| var key = loggerName ?? string.Empty; | ||
| if (LoggerCache.TryGetValue(key, out var logger)) | ||
| { | ||
| return logger; | ||
| } | ||
|
|
||
| var factory = _getLoggerFactory; | ||
| if (factory is null) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| logger = factory(loggerName); | ||
| if (logger is not null) | ||
| { | ||
| LoggerCache[key] = logger; | ||
| } | ||
|
|
||
| return logger; | ||
| } | ||
|
|
||
| private IEnumerable<KeyValuePair<string, object?>>? GetLogEventProperties(LogEventInfo logEvent) | ||
| { | ||
| // Check HasProperties first to avoid allocating empty dictionary | ||
| if (!logEvent.HasProperties && ContextProperties.Count == 0) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| var allProperties = GetAllProperties(logEvent); | ||
| if (allProperties.Count == 0) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| return allProperties.Select(kvp => new KeyValuePair<string, object?>(Convert.ToString(kvp.Key)!, kvp.Value)); | ||
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.