Skip to content

[INSTALL] Resolve dependencies in opentelemetry-cpp-config.cmake#3094

Merged
marcalff merged 4 commits intoopen-telemetry:mainfrom
tobim:cmake-config-find-dependencies
Oct 30, 2024
Merged

[INSTALL] Resolve dependencies in opentelemetry-cpp-config.cmake#3094
marcalff merged 4 commits intoopen-telemetry:mainfrom
tobim:cmake-config-find-dependencies

Conversation

@tobim
Copy link
Contributor

@tobim tobim commented Oct 12, 2024

Before this change, consumers of the exported CMake targets had to know which dependencies are needed to get the transitive target dependencies like absl::*, gRPC::grpc++, or protobuf::libprotobuf.

Fixes # (issue)

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

@tobim
Resolve dependencies in opentelemetry-cpp-config.cmake
6252f46 
Before this change, consumers of the exported CMake targets had to know
which dependencies are needed to get the transitive target dependencies
like `absl::*`, `gRPC::grpc++`, or `protobuf::libprotobuf`.
@tobim tobim requested a review from a team as a code owner October 12, 2024 12:23
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Oct 12, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@netlify
Copy link

netlify bot commented Oct 12, 2024 •
edited
Loading

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

Name Link
🔨 Latest commit 7225046
🔍 Latest deploy log https://app.netlify.com/sites/opentelemetry-cpp-api-docs/deploys/67211cfe9f75e50009cc4ab5

@codecov
Copy link

codecov bot commented Oct 13, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.91%. Comparing base (497eaf4) to head (7225046).
Report is 150 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3094      +/-   ##
==========================================
+ Coverage   87.12%   87.91%   +0.79%     
==========================================
  Files         200      195       -5     
  Lines        6109     6133      +24     
==========================================
+ Hits         5322     5391      +69     
+ Misses        787      742      -45

see 98 files with indirect coverage changes

@owent
Copy link
Member

owent commented Oct 14, 2024

find_package will produce warning when it's called recursively.
Shoud we just add warnings to let users call find_package for dependencies before otel-cpp?

@tobim
Copy link
Contributor Author

tobim commented Oct 14, 2024

find_package will produce warning when it's called recursively.

What warnings? Calling find_package or find_dependency in config files is standard practice.

@tobim
Copy link
Contributor Author

tobim commented Oct 22, 2024

I now realize that my earlier response might has come across as rude, which I did not intend.
Please take a look at the docs for find_dependency here.
Quoting:

It is designed to be used in a Package Configuration File (<PackageName>Config.cmake).

May I humbly request that you take another look?

@owent
Copy link
Member

owent commented Oct 24, 2024 •
edited
Loading

find_package will produce warning when it's called recursively.

What warnings? Calling find_package or find_dependency in config files is standard practice.

Sorry, calling find_package recursively with FindXXX.cmake will produce warnings, but won't with CONFIG package. Could you please also add find_dependency for OpenTracing, prometheus-cpp, CURL and ZLIB ?

@tobim
Add find_dependency calls for remaining deps
b92f316 
Now we also resolve `OpenTracing`, and `prometheus-cpp`.

If necessary, `CURL` and `ZLIB` are also resolved.
@tobim
Copy link
Contributor Author

tobim commented Oct 26, 2024

Thanks for the heads-up! I added the rest.
Afaics CURL and ZLIB are only necessary when opentelemetry_http_client_curl is built as a static library, so I guarded that with NOT BUILD_SHARED_LIBS.

owent
owent approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@owent owent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

ThomsonTan
ThomsonTan reviewed Oct 29, 2024
View reviewed changes
owent
owent reviewed Oct 30, 2024
View reviewed changes
cmake/opentelemetry-cpp-config.cmake.in
find_dependency(Threads)

if(@WITH_ABSEIL@)
find_dependency(absl)
Copy link
Member

@owent owent Oct 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I add absl in #3041 , which alos consider protobuf's version and gRpc

@marcalff marcalff added the ok-to-merge The PR is ok to merge (has two approves or raised by a maintainer/approver and has one approve) label Oct 30, 2024
@marcalff marcalff changed the title Resolve dependencies in opentelemetry-cpp-config.cmake [INSTALL] Resolve dependencies in opentelemetry-cpp-config.cmake Oct 30, 2024
@marcalff marcalff merged commit 6292a6a into open-telemetry:main Oct 30, 2024
@tobim tobim deleted the cmake-config-find-dependencies branch October 30, 2024 17:42
@BrewTestBot BrewTestBot mentioned this pull request Nov 26, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@owent owent owent approved these changes

@ThomsonTan ThomsonTan ThomsonTan approved these changes

@lalitb lalitb lalitb approved these changes

Assignees

No one assigned

Labels

ok-to-merge The PR is ok to merge (has two approves or raised by a maintainer/approver and has one approve)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tobim @owent @ThomsonTan @lalitb @marcalff