Skip to content

Add SourceLink to native Windows DLL #4774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kielek merged 2 commits into from
Jan 19, 2026
Merged

Add SourceLink to native Windows DLL #4774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8274215
Add SourceLink to native Windows DLL
martincostello Jan 15, 2026
8d8edad
Include PDB files in output
martincostello Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions build/Build.Steps.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,16 @@ static void SupportVs2026IfAvailable()
{
foreach (var architecture in ArchitecturesForPlatform)
{
var source = NativeProfilerProject.Directory / "bin" / BuildConfiguration / architecture.ToString() /
$"{NativeProfilerProject.Name}.dll";
var sourceDir = NativeProfilerProject.Directory / "bin" / BuildConfiguration / architecture.ToString();
var sourceDll = sourceDir / $"{NativeProfilerProject.Name}.dll";
var sourcePdb = sourceDir / $"{NativeProfilerProject.Name}.pdb";
var dest = TracerHomeDirectory / $"win-{architecture}";

Log.Information($"Copying '{source}' to '{dest}'");
Log.Information($"Copying '{sourceDll}' to '{dest}'");
sourceDll.CopyToDirectory(dest, ExistsPolicy.FileOverwrite);

source.CopyToDirectory(dest, ExistsPolicy.FileOverwrite);
Log.Information($"Copying '{sourcePdb}' to '{dest}'");
sourcePdb.CopyToDirectory(dest, ExistsPolicy.FileOverwrite);
}
});

Expand Down
23 changes: 23 additions & 0 deletions ...Telemetry.AutoInstrumentation.Native/OpenTelemetry.AutoInstrumentation.Native.DLL.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@
<TargetName>OpenTelemetry.AutoInstrumentation.Native</TargetName>
<TargetExt>.dll</TargetExt>
</PropertyGroup>
<PropertyGroup>
<SourceLink>$(IntDir)source_link.json</SourceLink>
</PropertyGroup>
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
<ClCompile>
<WarningLevel>Level3</WarningLevel>
Expand Down Expand Up @@ -167,6 +170,7 @@
<ModuleDefinitionFile>.\OpenTelemetry.AutoInstrumentation.Native.def</ModuleDefinitionFile>
<CETCompat>true</CETCompat>
<DynamicBase>true</DynamicBase>
<AdditionalOptions>%22/SOURCELINK:$(SourceLink)%22 %(AdditionalOptions)</AdditionalOptions>
</Link>
<PreBuildEvent>
<Command>IF EXIST "$(SolutionDir)pre-build-events-cpp.bat" CALL "$(SolutionDir)pre-build-events-cpp.bat" "$(TargetPath)" "$(TargetFileName)" "$(TargetDir)" "$(TargetName)"</Command>
Expand Down Expand Up @@ -197,6 +201,7 @@
<ModuleDefinitionFile>.\OpenTelemetry.AutoInstrumentation.Native.def</ModuleDefinitionFile>
<CETCompat>true</CETCompat>
<DynamicBase>true</DynamicBase>
<AdditionalOptions>%22/SOURCELINK:$(SourceLink)%22 %(AdditionalOptions)</AdditionalOptions>
</Link>
<PreBuildEvent>
<Command>IF EXIST "$(SolutionDir)pre-build-events-cpp.bat" CALL "$(SolutionDir)pre-build-events-cpp.bat" "$(TargetPath)" "$(TargetFileName)" "$(TargetDir)" "$(TargetName)"</Command>
Expand Down Expand Up @@ -232,4 +237,22 @@
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
</ImportGroup>
<Target Name="GenerateSourceLink" BeforeTargets="ClCompile">
<PropertyGroup>
<_SrcRootDirectory>$([System.IO.Directory]::GetParent($(MSBuildThisFileDirectory.TrimEnd("\"))))</_SrcRootDirectory>
<_SrcRootDirectory>$([System.IO.Directory]::GetParent($(_SrcRootDirectory.TrimEnd("\"))))</_SrcRootDirectory>
<_SourceLinkRoot>$(_SrcRootDirectory.Replace("\", "\\"))</_SourceLinkRoot>
</PropertyGroup>
<PropertyGroup Condition=" '$(GITHUB_ACTIONS)' == 'true' ">
<_RemoteUri>$(GITHUB_SERVER_URL)/$(GITHUB_REPOSITORY)</_RemoteUri>
<_LatestCommit>$(GITHUB_SHA)</_LatestCommit>
</PropertyGroup>
<Exec Command="git config --get remote.origin.url" ConsoleToMsBuild="true" Condition=" '$(_RemoteUri)' == '' ">
<Output TaskParameter="ConsoleOutput" PropertyName="_RemoteUri" />
</Exec>
<Exec Command="git rev-parse HEAD" ConsoleToMsBuild="true" Condition=" '$(_LatestCommit)' == '' ">
<Output TaskParameter="ConsoleOutput" PropertyName="_LatestCommit" />
</Exec>
<WriteLinesToFile File="$(SourceLink)" Overwrite="true" Lines="{&quot;documents&quot;: { &quot;$(_SourceLinkRoot)\\*&quot; : &quot;$(_RemoteUri.Replace(&quot;.git&quot;, &quot;&quot;).Replace(&quot;github.com&quot;, &quot;raw.githubusercontent.com&quot;))/$(_LatestCommit)/*&quot; }}" />
</Target>
</Project>
4 changes: 3 additions & 1 deletion test/IntegrationTests/BuildTests.DistributionStructure_windows.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,5 +368,7 @@
\store\x86\net9.0\microsoft.extensions.primitives\8.0.0\lib\net10.0\Microsoft.Extensions.Primitives.dll,
\store\x86\net9.0\system.diagnostics.diagnosticsource\10.0.0\lib\net10.0\System.Diagnostics.DiagnosticSource.dll,
\win-x64\OpenTelemetry.AutoInstrumentation.Native.dll,
\win-x86\OpenTelemetry.AutoInstrumentation.Native.dll
\win-x64\OpenTelemetry.AutoInstrumentation.Native.pdb,
\win-x86\OpenTelemetry.AutoInstrumentation.Native.dll,
\win-x86\OpenTelemetry.AutoInstrumentation.Native.pdb
]
Loading