[INSTALL] Unify cmake install functions and dynamically set component dependencies #3368

dbarker · 2025-04-18T19:05:57Z

Fixes #3293 as followup to #3220

Changes

Unifies the cmake install commands into functions
- otel_add_component()
  - Create a component with targets and optional files for install
- otel_install_components()
  - Install all components created
- otel_install_cmake_config()
  - Installs the opentelemetry-cpp-config.cmake` and version files.
- otel_install_thirdparty_definitions()
  - Installs the third-party definitions file (cmake search modes and built-with versions)
Removes the static component definitions and mappings
- component to target, component to component, and component to thirdparty dependency mappings are now determined dynamically based on the CMake target properties LINK_LIBRARIES and INTERFACE_LINK_LIBRARIES.
Adds opentelemetry-cpp:: alias targets to support install and unify the public cmake interface to opentelemetry-cpp
- The same opentelemetry-cpp::<target> names imported with find_package can now be used when opentelmetry-cpp is built directly as a submodule (add_subdirectory) in a larger project.
- Adds a test in ci to verify the alias targets are created for the api and sdk components when using CMake's FetchContent module.
- Updates the INSTALL documentation to add notes on FetchContent usage

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

…ies based on target library links

netlify · 2025-04-18T19:06:20Z

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

Name	Link
🔨 Latest commit	`94dff15`
🔍 Latest deploy log	https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/681e4e993bd80e0008b472e7

codecov · 2025-04-18T19:19:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.05%. Comparing base (1e33bb5) to head (94dff15).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3368   +/-   ##
=======================================
  Coverage   90.05%   90.05%           
=======================================
  Files         212      212           
  Lines        6932     6932           
=======================================
  Hits         6242     6242           
  Misses        690      690

🚀 New features to boost your workflow:

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

…nt_install_commands

dbarker · 2025-04-27T21:09:32Z

Hi @owent, This PR is based on your requests for followup to #3220. Can you take a look and give some feedback?

owent · 2025-04-29T06:15:36Z

Hi @owent, This PR is based on your requests for followup to #3220. Can you take a look and give some feedback?

Sorry for the delay. I will review it some time later.

owent

Great job. I have a few questions after a quick look.
It's a big PR and I will test it locally later.

cmake/otel-install-functions.cmake

owent · 2025-04-29T13:13:34Z

cmake/otel-install-functions.cmake

+  endforeach()
+
+  configure_file(
+    "${CMAKE_SOURCE_DIR}/cmake/templates/thirdparty-dependency-definitions.cmake.in"


Maybe it's better to use the simular path as below? ("${CMAKE_CURRENT_LIST_DIR}/templates/thirdparty-dependency-definitions.cmake.in")

Good catch. Your change is right. It should use CMAKE_CURRENT_LIST_DIR to ensure the project builds/installs correctly if used as a submodule.

I've pushed a commit to use PROJECT_SOURCE_DIR here and where we set/get properties used for install. That should work better when this project is used as a submodule/subdirectory in a larger project.

cmake/find-package-support-functions.cmake

…d package. Use PROJECT_SOURCE_DIR for storing properties and configuring files

owent · 2025-05-01T11:28:14Z

I'm on holiday these days.Can I continue to review several day's later

…nt_install_commands

…ctory of an external project

dbarker · 2025-05-07T22:33:03Z

@owent - for when you get back from holiday :)

I've added a new test using CMake's FetchContent module and updated INSTALL documentation to include this as a supported approach to incorporate opentelemetry-cpp as a sub-module/sub-directory in an external CMake project.

…. Clean up cmake script debug and error messages

…nt_install_commands

owent · 2025-05-09T16:57:08Z

cmake/templates/component-definitions.cmake.in

+# COMPONENT to TARGET lists
+# ----------------------------------------------------------------------
+
+@OTEL_COMPONENTS_TARGETS_BLOCK@


Can we also generate the target list comments in cmake/templates/opentelemetry-cpp-config.cmake.in?

Yeah. That is a good idea. What do you think about just removing the current comments listing targets and components then adding a comment pointing to the component-definitions.cmake file installed? That file contains all the information - just not in an .rst format.

Added a follow up issue. #3398

owent

Excellent job. I have already tested in my project. It works well.

marcalff · 2025-05-12T15:54:27Z

Excellent job. I have already tested in my project. It works well.

This says it all. Ok to merge.

owent · 2025-05-13T11:08:42Z

Excellent job. I have already tested in my project. It works well.

This says it all. Ok to merge.

Yes, LGTM. I think we can continue to work on generating document comments in another PR.

marcalff

LGTM, thanks for the fix.

unify cmake install functions and dynamically set component dependenc…

e2ed17f

…ies based on target library links

fix spelling

8c01d49

dbarker marked this pull request as ready for review April 19, 2025 00:09

dbarker requested a review from a team as a code owner April 19, 2025 00:09

dbarker added 2 commits April 25, 2025 14:49

Merge remote-tracking branch 'origin/main' into feature_unify_compone…

188dfa3

…nt_install_commands

changelog entry

445a7c9

Merge branch 'main' into feature_unify_component_install_commands

66a97b6

owent reviewed Apr 29, 2025

View reviewed changes

address review feedback. Shortcut finding depedencies on the installe…

21d0b35

…d package. Use PROJECT_SOURCE_DIR for storing properties and configuring files

ThomsonTan assigned owent Apr 30, 2025

dbarker added 3 commits May 7, 2025 12:09

Merge remote-tracking branch 'origin/main' into feature_unify_compone…

ad5c8d3

…nt_install_commands

add a CMake FetchContent test to build opentelemetry-cpp as a subdire…

4ba69fd

…ctory of an external project

update install documentation to include CMake FetchContent usage

92ab6da

dbarker mentioned this pull request May 8, 2025

CMake install for opentelemetry-cpp-contrib in-tree build was broken #3392

Open

fail otel_add_component if a target's EXPORT_NAME property is not set…

a4512ce

…. Clean up cmake script debug and error messages

dbarker mentioned this pull request May 8, 2025

[BUILD] Fix typo in find-package-support-functions.cmake for third_party dependencies #3395

Closed

3 tasks

lalitb and others added 2 commits May 8, 2025 22:29

Merge branch 'main' into feature_unify_component_install_commands

2361289

Merge remote-tracking branch 'origin/main' into feature_unify_compone…

c4a758a

…nt_install_commands

owent reviewed May 9, 2025

View reviewed changes

owent approved these changes May 9, 2025

View reviewed changes

Merge branch 'main' into feature_unify_component_install_commands

94dff15

This was referenced May 9, 2025

Auto generate documentation for cmake components #3398

Open

Use the public read-only opentelemetry-cpp namespace cmake targets in examples #3399

Closed

marcalff approved these changes May 14, 2025

View reviewed changes

marcalff merged commit 546fcd7 into open-telemetry:main May 14, 2025
67 checks passed

malkia mentioned this pull request May 14, 2025

[INSTALL] Unify cmake install functions and dynamically set component… malkia/opentelemetry-cpp#286

Merged

3 tasks

dbarker deleted the feature_unify_component_install_commands branch May 15, 2025 03:35

dbarker mentioned this pull request May 16, 2025

[CMAKE] update cmake files in examples directory #3421

Merged

3 tasks

BrewTestBot mentioned this pull request May 29, 2025

opentelemetry-cpp 1.21.0 Homebrew/homebrew-core#225080

Merged

[INSTALL] Unify cmake install functions and dynamically set component dependencies #3368

[INSTALL] Unify cmake install functions and dynamically set component dependencies #3368

Uh oh!

Conversation

dbarker commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

netlify bot commented Apr 18, 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 Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbarker commented Apr 27, 2025

Uh oh!

owent commented Apr 29, 2025

Uh oh!

owent left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

owent Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

dbarker Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbarker Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

owent commented May 1, 2025

Uh oh!

dbarker commented May 7, 2025

Uh oh!

owent May 9, 2025

Choose a reason for hiding this comment

Uh oh!

dbarker May 9, 2025

Choose a reason for hiding this comment

Uh oh!

dbarker May 9, 2025

Choose a reason for hiding this comment

Uh oh!

owent left a comment

Choose a reason for hiding this comment

Uh oh!

marcalff commented May 12, 2025

Uh oh!

owent commented May 13, 2025

Uh oh!

marcalff left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dbarker commented Apr 18, 2025 •

edited

Loading

netlify bot commented Apr 18, 2025 •

edited

Loading

codecov bot commented Apr 18, 2025 •

edited

Loading

dbarker Apr 29, 2025 •

edited

Loading

dbarker Apr 29, 2025 •

edited

Loading