open-telemetry
/
opentelemetry-dotnet-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Validate OpenTelemetry SDK version in StartupHook (#1692) 

* Add check for existing OpenTelemetry SDK.

* PR feedback

* fix nullable issues

* PR feedback

* Variable rename.

* not equal

Co-authored-by: Robert Pająk <pellared@hotmail.com>
Co-authored-by: Piotr Kiełkowicz <pkiekowicz@splunk.com>
This commit is contained in:
Rajkumar Rangaraj 2022-12-07 13:56:45 -08:00 committed by GitHub
parent 000bec3318
commit 0470ad47eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/OpenTelemetry.AutoInstrumentation.StartupHook/StartupHook.cs
View File

@ -16,6 +16,7 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Reflection;
using System.Runtime.Versioning;
@ -69,6 +70,8 @@ internal class StartupHook
if (profilerType == null)
{
ThrowIfReferenceIncorrectOpenTelemetryVersion(loaderAssemblyLocation);
// Instrumentation is not initialized.
// Creating an instance of OpenTelemetry.AutoInstrumentation.Loader.Startup
// will initialize Instrumentation through its static constructor.
@ -164,4 +167,51 @@ internal class StartupHook
return null;
}
}
private static void ThrowIfReferenceIncorrectOpenTelemetryVersion(string loaderAssemblyLocation)
{
var appReferenceAssemblies = Assembly.GetEntryAssembly()?.GetReferencedAssemblies();
if (appReferenceAssemblies == null)
{
return;
}
var index = Array.FindIndex(appReferenceAssemblies, assembly => assembly.Name == "OpenTelemetry");
string? oTelPackageVersion = null;
if (index != -1)
{
try
{
// Look up for type with an assembly name, will load the library.
// OpenTelemetry assembly load happens only if app has reference to the package.
var openTelemetryType = Type.GetType("OpenTelemetry.Sdk, OpenTelemetry");
if (openTelemetryType != null)
{
var loadedOTelAssembly = Assembly.GetAssembly(openTelemetryType);
var loadedOTelFileVersionInfo = FileVersionInfo.GetVersionInfo(loadedOTelAssembly?.Location);
var loadedOTelfileVersion = new Version(loadedOTelFileVersionInfo.FileVersion);
var autoInstrumentationOTelLocation = Path.Combine(loaderAssemblyLocation, "OpenTelemetry.dll");
var autoInstrumentationOTelFileVersionInfo = FileVersionInfo.GetVersionInfo(autoInstrumentationOTelLocation);
var autoInstrumentationOTelFileVersion = new Version(autoInstrumentationOTelFileVersionInfo.FileVersion);
if (loadedOTelfileVersion < autoInstrumentationOTelFileVersion)
{
oTelPackageVersion = loadedOTelFileVersionInfo.FileVersion;
}
}
}
catch (Exception ex)
{
// Exception in evaluation should not throw or crash the process.
StartupHookEventSource.Log.Trace($"Couldn't evaluate reference to OpenTelemetry Sdk in an app. Exception: {ex}");
}
}
if (oTelPackageVersion != null)
{
throw new NotSupportedException($"Application has direct or indirect reference to older version of OpenTelemetry package {oTelPackageVersion}.");
}
}
}