[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through common_foo_library #3440

ThomsonTan · 2025-05-23T03:10:05Z

Fixes #3439

Changes

Please provide a brief description of the changes here.

For significant contributions please make sure you have completed the following items:

CHANGELOG.md updated for non-trivial changes
Unit tests have been added
Changes in public API reviewed

…on_foo_library

netlify · 2025-05-23T03:10:09Z

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Name	Link
🔨 Latest commit	`59d1fea`
🔍 Latest deploy log	https://app.netlify.com/projects/opentelemetry-cpp-api-docs/deploys/683774bfb805c80008ac4c58

codecov · 2025-05-23T03:24:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.88%. Comparing base (d99593f) to head (59d1fea).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3440   +/-   ##
=======================================
  Coverage   89.88%   89.88%           
=======================================
  Files         212      212           
  Lines        6941     6941           
=======================================
  Hits         6238     6238           
  Misses        703      703

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dbarker · 2025-05-23T12:09:32Z

examples/common/foo_library/CMakeLists.txt

@@ -12,4 +12,4 @@ endif()

 target_include_directories(common_foo_library
                           PUBLIC "$<BUILD_INTERFACE:${EXAMPLES_COMMON_DIR}>")
-target_link_libraries(common_foo_library PRIVATE opentelemetry-cpp::api)


The example common foo library headers don't expose otel-cpp headers and that seems to be an important aspect of the example (user instrumentation of a library shouldn't leak otel-cpp if it doesn't need to).

If the executable linking to the dll target opentelemetry-cpp::opentelemetry_cpp isn't getting the definitions it needs from the api target, then it points to a missing link by the dll target.

Can you try adding target_link_libraries(opentelemetry_cpp INTERFACE opentelemetry_api) to the dll's cmake file?

opentelemetry-cpp/ext/src/dll/CMakeLists.txt

Line 7 in 4b6f52a

add_library(opentelemetry_cpp SHARED dllmain.cc ${OPENTELEMETRY_EXPORT_DEF})

No strong opinion whether the original fix from @ThomsonTan or the suggestion from @dbarker is the best solution.

Please resolve the code review, so a fix we all agree with can go in the repo.

This is blocking for the next release 1.21.0, as we want to make sure that examples work properly with a consistent build, it affects people trying / evaluating opentelemetry-cpp.

@marcalff Okay to merge now to fix the new examples build and unblock the release.

Users who link to the dll target in their projects will need to explicitly link the API target to get its declarations until we add the API link to the dll target. This can be done in the next release since the issue is not new

I think the suggestion from @dbarker with target_link_libraries(opentelemetry_cpp INTERFACE opentelemetry_api) could fix the issue, but I suspect the same issue could happen to non-DLL case, probably somehow there is some fallback for the linking in the same executable.

I also suggest we merge the current PR and tune the fix later (after the release), because the current PR restores the previous behavior.

File a new issue to track the follow-up #3447.

dbarker · 2025-05-23T12:15:30Z

Can you add a test in ci to cover the error you're seeing?

ThomsonTan · 2025-05-28T20:44:19Z

Can you add a test in ci to cover the error you're seeing?

I am running a repro for the issue in below draft, and post it back once it is ready.

#3441

ThomsonTan · 2025-05-28T21:36:17Z

Can you add a test in ci to cover the error you're seeing?

I am running a repro for the issue in below draft, and post it back once it is ready.

#3441

And the unresolved symbol issue for linking does repro in the CI build. I'll clean PR #3441 to make it ready for review, but I think it doesn't block the coming release.

https://github.com/open-telemetry/opentelemetry-cpp/actions/runs/15309964132/job/43072033016?pr=3441

D:\a\opentelemetry-cpp\opentelemetry-cpp\build\examples\simple\Debug\example_simple.exe : fatal error LNK1120: 1 unresolved externals [D:\a\opentelemetry-cpp\opentelemetry-cpp\build\examples\simple\example_simple.vcxproj]
main.obj : error LNK2019: unresolved external symbol "public: static void __cdecl opentelemetry::v1::sdk::logs::Provider::SetLoggerProvider(class opentelemetry::v1::nostd::shared_ptr const &)" (?SetLoggerProvider@Provider@logs@sdk@v1@opentelemetry@@SAXAEBV?$shared_ptr@VLoggerProvider@logs@v1@opentelemetry@@@nostd@45@@z) referenced in function "void __cdecl anonymous namespace'::InitLogger(void)" (?InitLogger@?A0x8fabb68e@@YAXXZ) [D:\a\opentelemetry-cpp\opentelemetry-cpp\build\examples\logs_simple\example_logs_simple.vcxproj] main.obj : error LNK2019: unresolved external symbol "__declspec(dllimport) public: static void __cdecl opentelemetry::v1::sdk::trace::Provider::SetTracerProvider(class opentelemetry::v1::nostd::shared_ptr<class opentelemetry::v1::trace::TracerProvider> const &)" (__imp_?SetTracerProvider@Provider@trace@sdk@v1@opentelemetry@@SAXAEBV?$shared_ptr@VTracerProvider@trace@v1@opentelemetry@@@nostd@45@@Z) referenced in function "void __cdecl anonymous namespace'::InitTracer(void)" (?InitTracer@?A0x8fabb68e@@yaxxz) [D:\a\opentelemetry-cpp\opentelemetry-cpp\build\examples\logs_simple\example_logs_simple.vcxproj]

marcalff · 2025-05-28T22:00:42Z

@ThomsonTan @dbarker So, for clarity: ok to merge this PR, 3440, as is then ?

ThomsonTan · 2025-05-28T22:03:21Z

@ThomsonTan @dbarker So, for clarity: ok to merge this PR, 3440, as is then ?

Yes, it is good to merge the current PR on my side and include it in the pending release. Will see if there is any further feedback from @dbarker.

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through comm…

04c609c

…on_foo_library

ThomsonTan requested a review from a team as a code owner May 23, 2025 03:10

Update PR number

4925109

dbarker reviewed May 23, 2025

View reviewed changes

ThomsonTan and others added 3 commits May 23, 2025 06:15

Merge branch 'main' into fix_dll_examples

106dc93

Merge branch 'main' into fix_dll_examples

66c07f6

Merge branch 'main' into fix_dll_examples

35b7f87

owent approved these changes May 27, 2025

View reviewed changes

marcalff mentioned this pull request May 26, 2025

[RELEASE] Prepare release opentelemetry-cpp 1.21.0 #3404

Closed

marcalff added issue:blocking This issue is preventing other fixes pr:please-review This PR is ready for review labels May 28, 2025

Merge branch 'main' into fix_dll_examples

59d1fea

ThomsonTan mentioned this pull request May 28, 2025

Propagate macro definitions from opentelemetry-cpp::api to all dependents #3447

Open

marcalff merged commit 793c7bd into open-telemetry:main May 28, 2025
67 checks passed

marcalff removed issue:blocking This issue is preventing other fixes pr:please-review This PR is ready for review labels May 28, 2025

malkia mentioned this pull request May 28, 2025

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through comm… malkia/opentelemetry-cpp#318

Merged

3 tasks

BrewTestBot mentioned this pull request May 29, 2025

opentelemetry-cpp 1.21.0 Homebrew/homebrew-core#225080

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through common_foo_library #3440

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through common_foo_library #3440

Uh oh!

ThomsonTan commented May 23, 2025

Uh oh!

netlify bot commented May 23, 2025 •

edited

Loading

Uh oh!

codecov bot commented May 23, 2025 •

edited

Loading

Uh oh!

dbarker May 23, 2025

Uh oh!

marcalff May 28, 2025

Uh oh!

dbarker May 28, 2025

Uh oh!

ThomsonTan May 28, 2025

Uh oh!

dbarker commented May 23, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

marcalff commented May 28, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

Uh oh!

Uh oh!

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through common_foo_library #3440

[BUILD] Propagate INTERFACE_COMPILE_DEFINITIONS from API through common_foo_library #3440

Uh oh!

Conversation

ThomsonTan commented May 23, 2025

Changes

Uh oh!

netlify bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for opentelemetry-cpp-api-docs canceled.

Uh oh!

codecov bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbarker May 23, 2025

Choose a reason for hiding this comment

Uh oh!

marcalff May 28, 2025

Choose a reason for hiding this comment

Uh oh!

dbarker May 28, 2025

Choose a reason for hiding this comment

Uh oh!

ThomsonTan May 28, 2025

Choose a reason for hiding this comment

Uh oh!

dbarker commented May 23, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

marcalff commented May 28, 2025

Uh oh!

ThomsonTan commented May 28, 2025

Uh oh!

Uh oh!

Uh oh!

netlify bot commented May 23, 2025 •

edited

Loading

codecov bot commented May 23, 2025 •

edited

Loading