chore: rename soname to Pyroscope.Profiler.Native (#120)

korniltsev-grafanista · web-flow · commit ffd60de765cd · 2025-09-25T19:41:55.000+07:00
* chore: rename soname to Pyroscope.Profiler.Native * Revert "chore: rename soname to Pyroscope.Profiler.Native" This reverts commit 377f525. * hopefully break integration test * Reapply "chore: rename soname to Pyroscope.Profiler.Native" This reverts commit 9b44c1f. * revert debug log * large runners for integration tests * large runners * maybe fix alpine tests * print an error message
diff --git a/.github/workflows/integration_test.yml b/.github/workflows/integration_test.yml
@@ -12,7 +12,7 @@ permissions:
 jobs:
   build-profiler-images:
     name: Build Profiler Image
-    runs-on: ubuntu-x64-small
+    runs-on: ubuntu-x64-large
     strategy:
       matrix:
         flavour:
@@ -39,7 +39,7 @@ jobs:
   run-integration-test:
     name: Run Integration Test
     needs: build-profiler-images
-    runs-on: ubuntu-x64-small
+    runs-on: ubuntu-x64-large
     strategy:
       fail-fast: false
       matrix:
diff --git a/Pyroscope.Dockerfile b/Pyroscope.Dockerfile
@@ -30,9 +30,9 @@ RUN mkdir build-${CMAKE_BUILD_TYPE} && \
         -DCMAKE_CXX_FLAGS_DEBUG="-g -O0" \
         -DCMAKE_C_FLAGS_DEBUG="-g -O0"
 
-RUN cd build-${CMAKE_BUILD_TYPE} && make -j16 Datadog.Profiler.Native Datadog.Linux.ApiWrapper.x64
+RUN cd build-${CMAKE_BUILD_TYPE} && make -j16 Pyroscope.Profiler.Native Datadog.Linux.ApiWrapper.x64
 
 FROM busybox:1.36.1-glibc
-COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux/Datadog.Profiler.Native.so /Pyroscope.Profiler.Native.so
+COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux/Pyroscope.Profiler.Native.so /Pyroscope.Profiler.Native.so
 COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux/Datadog.Linux.ApiWrapper.x64.so /Pyroscope.Linux.ApiWrapper.x64.so
 
diff --git a/Pyroscope.musl.Dockerfile b/Pyroscope.musl.Dockerfile
@@ -38,9 +38,9 @@ RUN mkdir build-${CMAKE_BUILD_TYPE} && \
         -DCMAKE_CXX_FLAGS_DEBUG="-g -O0" \
         -DCMAKE_C_FLAGS_DEBUG="-g -O0"
 
-RUN cd build-${CMAKE_BUILD_TYPE} && make -j16 Datadog.Profiler.Native Datadog.Linux.ApiWrapper.x64
+RUN cd build-${CMAKE_BUILD_TYPE} && make -j16 Pyroscope.Profiler.Native Datadog.Linux.ApiWrapper.x64
 
 FROM busybox:1.36.1-musl
-COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux-musl/Datadog.Profiler.Native.so /Pyroscope.Profiler.Native.so
+COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux-musl/Pyroscope.Profiler.Native.so /Pyroscope.Profiler.Native.so
 COPY --from=builder /profiler/profiler/_build/DDProf-Deploy/linux-musl/Datadog.Linux.ApiWrapper.x64.so /Pyroscope.Linux.ApiWrapper.x64.so
 
diff --git a/Pyroscope/Pyroscope/Profiler.cs b/Pyroscope/Pyroscope/Profiler.cs
@@ -43,8 +43,9 @@ public void SetDynamicTag(string key, string value)
             {
                 NativeInterop.SetDynamicTag(key, value);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -59,8 +60,9 @@ public void ClearDynamicTags()
             {
                 NativeInterop.ClearDynamicTags();
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -80,8 +82,9 @@ public void SetCPUTrackingEnabled(bool enabled)
             {
                 NativeInterop.SetCPUTrackingEnabled(enabled);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -100,8 +103,9 @@ public void SetAllocationTrackingEnabled(bool enabled)
             {
                 NativeInterop.SetAllocationTrackingEnabled(enabled);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -120,8 +124,9 @@ public void SetContentionTrackingEnabled(bool enabled)
             {
                 NativeInterop.SetContentionTrackingEnabled(enabled);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -140,8 +145,9 @@ public void SetExceptionTrackingEnabled(bool enabled)
             {
                 NativeInterop.SetExceptionTrackingEnabled(enabled);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -156,8 +162,9 @@ public void SetAuthToken(string authToken)
             {
                 NativeInterop.SetAuthToken(authToken);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
@@ -172,11 +179,16 @@ public void SetBasicAuth(string username, string password)
             {
                 NativeInterop.SetBasicAuth(username, password);
             }
-            catch (DllNotFoundException)
+            catch (DllNotFoundException ex)
             {
+                DllNotFound(ex);
                 _dllNotFound = true;
             }
         }
+
+        private static void DllNotFound(DllNotFoundException ex) {
+            Console.WriteLine($"[Profiler] Failed to load Pyroscope.Profiler.Native.so : {ex}.\nConsider setting LD_LIBRARY_PATH pointing to the directory containing the Pyroscope.Profiler.Native.so");
+        }
         
         private readonly ContextTracker _contextTracker;
         private bool _dllNotFound;
diff --git a/itest.Dockerfile b/itest.Dockerfile
@@ -33,15 +33,19 @@ FROM --platform=linux/amd64 mcr.microsoft.com/dotnet/aspnet:$SDK_VERSION$SDK_IMA
 
 WORKDIR /dotnet
 
-COPY --from=sdk /Pyroscope.Profiler.Native.so ./Pyroscope.Profiler.Native.so
-COPY --from=sdk /Pyroscope.Linux.ApiWrapper.x64.so ./Pyroscope.Linux.ApiWrapper.x64.so
+# place the binaries in a subfolder - to rigger a problme when SONAME was Datadog.Profiler.Native
+# and dynamic linker could not find the profiler lib.
+COPY --from=sdk /Pyroscope.Profiler.Native.so ./subfolder/Pyroscope.Profiler.Native.so
+COPY --from=sdk /Pyroscope.Linux.ApiWrapper.x64.so ./subfolder/Pyroscope.Linux.ApiWrapper.x64.so
 COPY --from=build /dotnet/app ./
 
+# Fix for alpine not being able to dlopen an already loaded library
+ENV LD_LIBRARY_PATH=/dotnet/subfolder/
 
 ENV CORECLR_ENABLE_PROFILING=1
 ENV CORECLR_PROFILER={BD1A650D-AC5D-4896-B64F-D6FA25D6B26A}
-ENV CORECLR_PROFILER_PATH=/dotnet/Pyroscope.Profiler.Native.so
-ENV LD_PRELOAD=/dotnet/Pyroscope.Linux.ApiWrapper.x64.so
+ENV CORECLR_PROFILER_PATH=/dotnet/subfolder/Pyroscope.Profiler.Native.so
+ENV LD_PRELOAD=/dotnet/subfolder/Pyroscope.Linux.ApiWrapper.x64.so
 
 ENV PYROSCOPE_SERVER_ADDRESS=http://pyroscope:4040
 ENV PYROSCOPE_LOG_LEVEL=debug
diff --git a/profiler/CMakeLists.txt b/profiler/CMakeLists.txt
@@ -143,7 +143,7 @@ enable_testing()
 add_subdirectory(test)
 
 add_custom_target(profiler)
-add_dependencies(profiler Datadog.Profiler.Native)
+add_dependencies(profiler Pyroscope.Profiler.Native)
 
 add_custom_target(all-profiler)
 add_dependencies(all-profiler profiler profiler-native-tests)
diff --git a/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/CMakeLists.txt b/profiler/src/ProfilerEngine/Datadog.Profiler.Native.Linux/CMakeLists.txt
@@ -55,7 +55,7 @@ endif()
 # Environment detection
 # ******************************************************
 
-SET(PROFILER_BASENAME Datadog.Profiler.Native)
+SET(PROFILER_BASENAME Pyroscope.Profiler.Native)
 SET(PROFILER_STATIC_LIB_NAME ${PROFILER_BASENAME}.static)
 SET(PROFILER_SHARED_LIB_NAME ${PROFILER_BASENAME})
 
diff --git a/profiler/test/Datadog.Profiler.Native.Tests/CMakeLists.txt b/profiler/test/Datadog.Profiler.Native.Tests/CMakeLists.txt
@@ -63,7 +63,7 @@ target_include_directories(${TEST_EXECUTABLE_NAME}
     PUBLIC ${googletest_SOURCE_DIR}/googlemock/include
 )
 
-add_dependencies(${TEST_EXECUTABLE_NAME} gmock gtest Datadog.Profiler.Native.static libunwind)
+add_dependencies(${TEST_EXECUTABLE_NAME} gmock gtest Pyroscope.Profiler.Native.static libunwind)
 
 if (RUN_ASAN)
     target_link_libraries(${TEST_EXECUTABLE_NAME} -fsanitize=address)
@@ -74,7 +74,7 @@ if (RUN_UBSAN)
 endif()
 
 target_link_libraries(${TEST_EXECUTABLE_NAME}
-  Datadog.Profiler.Native.static
+  Pyroscope.Profiler.Native.static
   gtest_main
   gmock_main
   -static-libgcc

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,9 @@ public void SetDynamicTag(string key, string value)`
`43`	`43`	`{`
`44`	`44`	`NativeInterop.SetDynamicTag(key, value);`
`45`	`45`	`}`
`46`		`- catch (DllNotFoundException)`
	`46`	`+ catch (DllNotFoundException ex)`
`47`	`47`	`{`
	`48`	`+ DllNotFound(ex);`
`48`	`49`	`_dllNotFound = true;`
`49`	`50`	`}`
`50`	`51`	`}`
`@@ -59,8 +60,9 @@ public void ClearDynamicTags()`
`59`	`60`	`{`
`60`	`61`	`NativeInterop.ClearDynamicTags();`
`61`	`62`	`}`
`62`		`- catch (DllNotFoundException)`
	`63`	`+ catch (DllNotFoundException ex)`
`63`	`64`	`{`
	`65`	`+ DllNotFound(ex);`
`64`	`66`	`_dllNotFound = true;`
`65`	`67`	`}`
`66`	`68`	`}`
`@@ -80,8 +82,9 @@ public void SetCPUTrackingEnabled(bool enabled)`
`80`	`82`	`{`
`81`	`83`	`NativeInterop.SetCPUTrackingEnabled(enabled);`
`82`	`84`	`}`
`83`		`- catch (DllNotFoundException)`
	`85`	`+ catch (DllNotFoundException ex)`
`84`	`86`	`{`
	`87`	`+ DllNotFound(ex);`
`85`	`88`	`_dllNotFound = true;`
`86`	`89`	`}`
`87`	`90`	`}`
`@@ -100,8 +103,9 @@ public void SetAllocationTrackingEnabled(bool enabled)`
`100`	`103`	`{`
`101`	`104`	`NativeInterop.SetAllocationTrackingEnabled(enabled);`
`102`	`105`	`}`
`103`		`- catch (DllNotFoundException)`
	`106`	`+ catch (DllNotFoundException ex)`
`104`	`107`	`{`
	`108`	`+ DllNotFound(ex);`
`105`	`109`	`_dllNotFound = true;`
`106`	`110`	`}`
`107`	`111`	`}`
`@@ -120,8 +124,9 @@ public void SetContentionTrackingEnabled(bool enabled)`
`120`	`124`	`{`
`121`	`125`	`NativeInterop.SetContentionTrackingEnabled(enabled);`
`122`	`126`	`}`
`123`		`- catch (DllNotFoundException)`
	`127`	`+ catch (DllNotFoundException ex)`
`124`	`128`	`{`
	`129`	`+ DllNotFound(ex);`
`125`	`130`	`_dllNotFound = true;`
`126`	`131`	`}`
`127`	`132`	`}`
`@@ -140,8 +145,9 @@ public void SetExceptionTrackingEnabled(bool enabled)`
`140`	`145`	`{`
`141`	`146`	`NativeInterop.SetExceptionTrackingEnabled(enabled);`
`142`	`147`	`}`
`143`		`- catch (DllNotFoundException)`
	`148`	`+ catch (DllNotFoundException ex)`
`144`	`149`	`{`
	`150`	`+ DllNotFound(ex);`
`145`	`151`	`_dllNotFound = true;`
`146`	`152`	`}`
`147`	`153`	`}`
`@@ -156,8 +162,9 @@ public void SetAuthToken(string authToken)`
`156`	`162`	`{`
`157`	`163`	`NativeInterop.SetAuthToken(authToken);`
`158`	`164`	`}`
`159`		`- catch (DllNotFoundException)`
	`165`	`+ catch (DllNotFoundException ex)`
`160`	`166`	`{`
	`167`	`+ DllNotFound(ex);`
`161`	`168`	`_dllNotFound = true;`
`162`	`169`	`}`
`163`	`170`	`}`
`@@ -172,11 +179,16 @@ public void SetBasicAuth(string username, string password)`
`172`	`179`	`{`
`173`	`180`	`NativeInterop.SetBasicAuth(username, password);`
`174`	`181`	`}`
`175`		`- catch (DllNotFoundException)`
	`182`	`+ catch (DllNotFoundException ex)`
`176`	`183`	`{`
	`184`	`+ DllNotFound(ex);`
`177`	`185`	`_dllNotFound = true;`
`178`	`186`	`}`
`179`	`187`	`}`
	`188`	`+`
	`189`	`+ private static void DllNotFound(DllNotFoundException ex) {`
	`190`	`+ Console.WriteLine($"[Profiler] Failed to load Pyroscope.Profiler.Native.so : {ex}.\nConsider setting LD_LIBRARY_PATH pointing to the directory containing the Pyroscope.Profiler.Native.so");`
	`191`	`+ }`
`180`	`192`
`181`	`193`	`private readonly ContextTracker _contextTracker;`
`182`	`194`	`private bool _dllNotFound;`