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
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
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
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,80 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System.Reflection; | ||
| using OpenTelemetry.AutoInstrumentation.DuckTyping; | ||
| using OpenTelemetry.AutoInstrumentation.Logging; | ||
|
|
||
| namespace OpenTelemetry.AutoInstrumentation.Instrumentations.NLog.AutoInjection; | ||
|
|
||
| internal static class NLogAutoInjector | ||
| { | ||
| private static readonly IOtelLogger Logger = OtelLogging.GetLogger(); | ||
| private static int _attempted; | ||
|
|
||
| public static void EnsureConfigured() | ||
| { | ||
| if (Interlocked.Exchange(ref _attempted, 1) != 0) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| try | ||
| { | ||
| var nlogLogManager = Type.GetType("NLog.LogManager, NLog"); | ||
| if (nlogLogManager is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var configurationProperty = nlogLogManager.GetProperty("Configuration", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic); | ||
| if (configurationProperty is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var configuration = configurationProperty.GetValue(null); | ||
| if (configuration is null) | ||
| { | ||
| var configurationType = Type.GetType("NLog.Config.LoggingConfiguration, NLog"); | ||
| configuration = Activator.CreateInstance(configurationType!); | ||
| configurationProperty.SetValue(null, configuration); | ||
| } | ||
|
|
||
| // Create the OpenTelemetry target instance and wrap it in a duck proxy | ||
| var otelTarget = new OpenTelemetryTarget(); | ||
| var targetType = Type.GetType("NLog.Targets.TargetWithContext, NLog", false); | ||
| if (targetType is null) | ||
| { | ||
| Logger.Warning("NLog auto-injection skipped: TargetWithContext type not found."); | ||
| return; | ||
| } | ||
|
|
||
| var targetProxy = otelTarget.DuckImplement(targetType); | ||
|
|
||
| // Add target to configuration | ||
| var addTargetMethod = configuration!.GetType().GetMethod("AddTarget", BindingFlags.Instance | BindingFlags.Public); | ||
| addTargetMethod?.Invoke(configuration, new object?[] { "otlp", targetProxy }); | ||
|
|
||
| // Create rule: * -> otlp (minlevel: Trace) | ||
| var loggingRuleType = Type.GetType("NLog.Config.LoggingRule, NLog"); | ||
| var logLevelType = Type.GetType("NLog.LogLevel, NLog"); | ||
| var traceLevel = logLevelType?.GetProperty("Trace", BindingFlags.Static | BindingFlags.Public)?.GetValue(null); | ||
| var rule = Activator.CreateInstance(loggingRuleType!, new object?[] { "*", traceLevel, targetProxy }); | ||
|
|
||
| var loggingRulesProp = configuration.GetType().GetProperty("LoggingRules", BindingFlags.Instance | BindingFlags.Public); | ||
| var rulesList = loggingRulesProp?.GetValue(configuration) as System.Collections.IList; | ||
| rulesList?.Add(rule); | ||
|
|
||
| // Apply configuration | ||
| var reconfigMethod = nlogLogManager.GetMethod("ReconfigExistingLoggers", BindingFlags.Static | BindingFlags.Public); | ||
| reconfigMethod?.Invoke(null, null); | ||
|
|
||
| Logger.Information("NLog OpenTelemetryTarget auto-injected."); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Logger.Warning(ex, "NLog OpenTelemetryTarget auto-injection failed."); | ||
| } | ||
| } | ||
| } |
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,109 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| using System.Diagnostics; | ||
| using System.Reflection; | ||
| using OpenTelemetry.AutoInstrumentation.CallTarget; | ||
| using OpenTelemetry.AutoInstrumentation.Instrumentations.NLog.AutoInjection; | ||
| using OpenTelemetry.AutoInstrumentation.Logging; | ||
| #if NET | ||
| using OpenTelemetry.AutoInstrumentation.Logger; | ||
| #endif | ||
|
|
||
| namespace OpenTelemetry.AutoInstrumentation.Instrumentations.NLog.Bridge.Integrations; | ||
|
|
||
| /// <summary> | ||
| /// NLog Logger integration that hooks into the actual logging process. | ||
| /// This integration intercepts NLog's Logger.Log method calls to automatically | ||
| /// capture log events and forward them to OpenTelemetry when the NLog bridge is enabled. | ||
| /// | ||
| /// The integration targets NLog.Logger.Log method which is the core method called | ||
| /// for all logging operations, allowing us to capture events without modifying configuration. | ||
| /// </summary> | ||
| [InstrumentMethod( | ||
| assemblyName: "NLog", | ||
| typeName: "NLog.Logger", | ||
| methodName: "Log", | ||
| returnTypeName: ClrNames.Void, | ||
| parameterTypeNames: new[] { "NLog.LogEventInfo" }, | ||
|
Comment on lines
+23
to
+28
There was a problem hiding this comment. I think that you need to revisit the way how you injecting bytecode.
Even when I have checked the testing application calling this method, it is failing. |
||
| minimumVersion: "5.0.0", | ||
| maximumVersion: "6.*.*", | ||
| integrationName: "NLog", | ||
| type: InstrumentationType.Log)] | ||
| public static class LoggerIntegration | ||
Kielek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| #if NET | ||
| private static readonly IOtelLogger Logger = OtelLogging.GetLogger(); | ||
| private static int _warningLogged; | ||
| #endif | ||
|
|
||
| /// <summary> | ||
| /// Intercepts NLog's Logger.Log method calls to capture log events. | ||
| /// This method is called before the original Log method executes, | ||
| /// allowing us to capture and forward log events to OpenTelemetry. | ||
| /// </summary> | ||
| /// <typeparam name="TTarget">The type of the logger instance.</typeparam> | ||
| /// <param name="instance">The NLog Logger instance.</param> | ||
| /// <param name="logEvent">The NLog LogEventInfo being logged.</param> | ||
| /// <returns>A CallTargetState (unused in this case).</returns> | ||
| internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance, ILoggingEvent logEvent) | ||
| { | ||
| #if NET | ||
| // Check if ILogger bridge has been initialized and warn if so | ||
| // This prevents conflicts between different logging bridges | ||
| if (LoggerInitializer.IsInitializedAtLeastOnce) | ||
| { | ||
| if (Interlocked.Exchange(ref _warningLogged, 1) != default) | ||
| { | ||
| return CallTargetState.GetDefault(); | ||
| } | ||
|
|
||
| Logger.Warning("Disabling NLog bridge due to ILogger bridge initialization."); | ||
| return CallTargetState.GetDefault(); | ||
| } | ||
| #endif | ||
|
|
||
| // Only process the log event if the NLog bridge is enabled | ||
| if (Instrumentation.LogSettings.Value.EnableNLogBridge) | ||
| { | ||
| // Ensure the OpenTelemetry NLog target is configured (zero-config path) | ||
| NLogAutoInjector.EnsureConfigured(); | ||
|
|
||
| // Inject trace context into NLog GlobalDiagnosticsContext for current destination outputs | ||
| TrySetTraceContext(Activity.Current); | ||
|
There was a problem hiding this comment. I think that this method should be called always, even if the bridge is not enabled. You need to set context also when you are injecting in to the typical NLog sinks. |
||
| } | ||
|
|
||
| // Return default state - we don't need to track anything between begin/end | ||
| return CallTargetState.GetDefault(); | ||
| } | ||
|
|
||
| private static void TrySetTraceContext(Activity? activity) | ||
| { | ||
| try | ||
| { | ||
| var gdcType = Type.GetType("NLog.GlobalDiagnosticsContext, NLog"); | ||
| if (gdcType is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var setMethod = gdcType.GetMethod("Set", BindingFlags.Public | BindingFlags.Static, null, [typeof(string), typeof(string)], null); | ||
| if (setMethod is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| string spanId = activity?.SpanId.ToString() ?? "(null)"; | ||
| string traceId = activity?.TraceId.ToString() ?? "(null)"; | ||
| string traceFlags = activity is null ? "(null)" : ((byte)activity.ActivityTraceFlags).ToString("x2"); | ||
|
|
||
| setMethod.Invoke(null, new object[] { "span_id", spanId }); | ||
| setMethod.Invoke(null, new object[] { "trace_id", traceId }); | ||
| setMethod.Invoke(null, new object[] { "trace_flags", traceFlags }); | ||
| } | ||
| catch | ||
| { | ||
| // best-effort only | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.