[PROF-8917] Add Ruby helper to get ld_library_path for libdatadog
#423
Conversation
This file contains 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
**What does this PR do?** This PR adds a `Libdatadog.ld_library_path` helper to the libdatadog Ruby support code. This helper returns the full path to the `lib/` folder where the libdatadog `.so` files are contained. **Motivation:** I'm adding this to support the crashtracker for Ruby: we need this information when starting the crashtracker, and rather than having the knowledge of folder layouts inside dd-trace-rb, I think it makes sense for the libdatadog Ruby code to keep this knowledge. **Additional Notes:** I'm planning to include this change in the libdatadog 9 release for Ruby. **How to test the change?** Test coverage is included (and CI runs these tests).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #423 +/- ##
=======================================
Coverage 65.36% 65.36%
=======================================
Files 184 184
Lines 22503 22503
=======================================
Hits 14710 14710
Misses 7793 7793
|
ivoanjo
added a commit
to DataDog/dd-trace-rb
that referenced
this pull request
May 9, 2024
This will be integrated into the libdatadog v9 release in DataDog/libdatadog#423 .
bantonsson
approved these changes
May 10, 2024
|
|
||
| return unless pkgconfig_folder | ||
|
|
||
| File.absolute_path("#{pkgconfig_folder}/../") |
There was a problem hiding this comment.
I trust you know what you are doing... 😉
There was a problem hiding this comment.
Ahaha thanks! To be clear, what this does is take the structure of our binary builds:
% tree
.
├── bin
│ └── libdatadog-crashtracking-receiver
├── cmake
│ └── DatadogConfig.cmake
├── include
│ └── datadog
│ ├── blazesym.h
│ ├── common.h
│ ├── profiling.h
│ └── telemetry.h
├── lib
│ ├── libdatadog_profiling.a
│ ├── libdatadog_profiling.so
│ ├── libdatadog_profiling.so.debug
│ └── pkgconfig
│ ├── datadog_profiling.pc
│ ├── datadog_profiling-static.pc
│ └── datadog_profiling_with_rpath.pc
├── LICENSE
├── LICENSE-3rdparty.yml
└── NOTICE
and encodes the knowledge that the .so file is in the parent folder to the pkgconfig file.
I could've implemented this another way (e.g. search for the so file directly or something), but since this is internal to the libdatadog helper, and we already have another helper that does this relative find thing, I just went with it.
(Since on the Ruby library side we only call these methods and don't encode any assumptions on the folder structure, we can always update the helpers and move stuff around whenever we want to).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
This PR adds a
Libdatadog.ld_library_pathhelper to the libdatadog Ruby support code.This helper returns the full path to the
lib/folder where the libdatadog.sofiles are contained.Motivation
I'm adding this to support the crashtracker for Ruby: we need this information when starting the crashtracker, and rather than having the knowledge of folder layouts inside dd-trace-rb, I think it makes sense for the libdatadog Ruby code to keep this knowledge.
Additional Notes
I'm planning to include this change in the libdatadog 9 release for Ruby.
How to test the change?
Test coverage is included (and CI runs these tests).