Rename cmake options with prefix OTELCPP_ by owent · Pull Request #4268 · open-telemetry/opentelemetry-cpp

owent · 2026-07-19T18:07:04Z

Changes

Rename cmake options with prefix OTELCPP_

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

Copilot

Pull request overview

This PR addresses CMake option namespace collisions when opentelemetry-cpp is consumed as a subproject (e.g., via FetchContent / add_subdirectory) by introducing an OTELCPP_ prefix for the project’s CMake options and wiring deprecated legacy names to the new ones.

Changes:

Introduces OTELCPP_* CMake options (and wrapper helpers) and updates build logic to prefer the new names while warning on legacy names.
Updates CMakeLists across components/tests/examples/CI scripts to use OTELCPP_* option checks.
Updates documentation, install tests, and packaging/config helpers to reference the new option names.

Reviewed changes

Copilot reviewed 103 out of 103 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tools/ports/opentelemetry/portfile.cmake	Updates example CMake option name in vcpkg port guidance
tools/build.cmd	Updates Windows build script to pass renamed options
test_common/src/http/client/nosend/CMakeLists.txt	Switches testing guard to `OTELCPP_BUILD_TESTING`
test_common/src/CMakeLists.txt	Switches test_common subdir guard to `OTELCPP_BUILD_TESTING`
test_common/CMakeLists.txt	Switches test_common target guard to `OTELCPP_BUILD_TESTING`
test_common/cmake/testing-options.cmake	Updates cached CI preset options to `OTELCPP_*` names
test_common/cmake/preview-options.cmake	Updates cached preview preset options to `OTELCPP_*` names
test_common/cmake/example-options.cmake	Updates cached example preset options to `OTELCPP_*` names
test_common/cmake/component-options.cmake	Updates cached component preset options to `OTELCPP_*` names
test_common/cmake/all-options-abiv2.cmake	Updates ABI v2 preset options to `OTELCPP_*` names
test_common/cmake/all-options-abiv2-preview.cmake	Updates ABI v2+preview preset options to `OTELCPP_*` names
test_common/cmake/all-options-abiv1.cmake	Updates ABI v1 preset options to `OTELCPP_*` names
test_common/cmake/all-options-abiv1-preview.cmake	Updates ABI v1+preview preset options to `OTELCPP_*` names
sdk/test/trace/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
sdk/test/metrics/CMakeLists.txt	Renames benchmark/preview option checks to `OTELCPP_*`
sdk/test/common/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
sdk/test/CMakeLists.txt	Renames configuration option checks to `OTELCPP_WITH_CONFIGURATION`
sdk/src/version/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/trace/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/resource/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/metrics/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/logs/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/configuration/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/common/CMakeLists.txt	Renames install option checks to `OTELCPP_INSTALL`
sdk/src/CMakeLists.txt	Renames configuration option checks to `OTELCPP_WITH_CONFIGURATION`
sdk/CMakeLists.txt	Renames configuration/testing option checks to `OTELCPP_*`
resource_detectors/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
opentracing-shim/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
install/test/cmake/fetch_content_test/CMakeLists.txt	Adds assertions validating subproject default for `OTELCPP_BUILD_TESTING`
install/test/cmake/examples_test/CMakeLists.txt	Updates installed-component test to set `OTELCPP_*` options
install/test/cmake/api_only_test/CMakeLists.txt	Updates API-only install test to use `OTELCPP_*` option names
INSTALL.md	Updates documented CMake flags to `OTELCPP_*` equivalents
functional/otlp/CMakeLists.txt	Renames functional test option checks to `OTELCPP_WITH_OTLP_*`
functional/CMakeLists.txt	Renames functional test option checks to `OTELCPP_WITH_OTLP_HTTP`
ext/test/w3c_tracecontext_http_test_server/CMakeLists.txt	Renames curl option checks to `OTELCPP_WITH_HTTP_CLIENT_CURL`
ext/test/http/CMakeLists.txt	Renames curl option checks to `OTELCPP_WITH_HTTP_CLIENT_CURL`
ext/test/CMakeLists.txt	Renames W3C test option checks to `OTELCPP_BUILD_W3CTRACECONTEXT_TEST`
ext/src/http/client/curl/http_client_curl.cc	Updates log message to reference `OTELCPP_WITH_OTLP_HTTP_COMPRESSION`
ext/src/http/client/curl/CMakeLists.txt	Renames curl/logging/compression option checks to `OTELCPP_*`
ext/src/dll/CMakeLists.txt	Renames exporter option checks to `OTELCPP_WITH_OTLP_*`
ext/src/CMakeLists.txt	Renames HTTP/client/DLL option checks to `OTELCPP_*`
ext/include/opentelemetry/ext/http/client/detail/default_factory.h	Updates error text to reference `OTELCPP_WITH_HTTP_CLIENT_CURL`
ext/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
exporters/zipkin/README.md	Updates build instructions to `OTELCPP_WITH_ZIPKIN`
exporters/zipkin/CMakeLists.txt	Renames install/testing/curl option checks to `OTELCPP_*`
exporters/prometheus/CMakeLists.txt	Renames install/testing option checks to `OTELCPP_*`
exporters/otlp/CMakeLists.txt	Renames exporter/testing/benchmark option checks to `OTELCPP_*`
exporters/ostream/CMakeLists.txt	Renames testing/install option checks to `OTELCPP_*`
exporters/memory/CMakeLists.txt	Renames install/testing option checks to `OTELCPP_*`
exporters/etw/CMakeLists.txt	Renames testing/benchmark option checks to `OTELCPP_*`
exporters/elasticsearch/CMakeLists.txt	Renames install/testing option checks to `OTELCPP_*`
exporters/CMakeLists.txt	Renames exporter option checks to `OTELCPP_WITH_*`
examples/tracer_configurator/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/simple/CMakeLists.txt	Renames DLL/testing option checks to `OTELCPP_*`
examples/plugin/CMakeLists.txt	Renames dynamic-loading/testing option checks to `OTELCPP_*`
examples/otlp/CMakeLists.txt	Renames OTLP/DLL option checks to `OTELCPP_*`
examples/multithreaded/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/multi_processor/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/metrics_simple/CMakeLists.txt	Renames DLL/testing option checks to `OTELCPP_*`
examples/logs_simple/CMakeLists.txt	Renames DLL/testing option checks to `OTELCPP_*`
examples/logger_configurator/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/http/CMakeLists.txt	Renames curl option checks to `OTELCPP_WITH_HTTP_CLIENT_CURL`
examples/explicit_parent/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/etw_threads/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/environment_carrier/CMakeLists.txt	Renames DLL/testing option checks to `OTELCPP_*`
examples/custom_http_client/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
examples/configuration/CMakeLists.txt	Renames exporter/DLL/testing option checks to `OTELCPP_*`
examples/common/metrics_foo_library/CMakeLists.txt	Renames DLL option check to `OTELCPP_BUILD_DLL`
examples/common/logs_foo_library/CMakeLists.txt	Renames DLL option check to `OTELCPP_BUILD_DLL`
examples/common/foo_library/CMakeLists.txt	Renames DLL option check to `OTELCPP_BUILD_DLL`
examples/CMakeLists.txt	Renames example gating options to `OTELCPP_*`
examples/batch/CMakeLists.txt	Renames testing option checks to `OTELCPP_BUILD_TESTING`
docs/deprecation-process.md	Updates deprecation documentation to use `OTELCPP_*` option names
docs/dependencies.md	Updates STL option reference to `OTELCPP_WITH_STL`
docs/build-as-dll.md	Updates DLL option reference to `OTELCPP_BUILD_DLL`
docs/abi-version-policy.md	Updates ABI option references to `OTELCPP_WITH_ABI_VERSION_*`
docs/abi-policy.md	Updates STL option reference to `OTELCPP_WITH_STL`
docker/Dockerfile	Updates docker build flags to `OTELCPP_*` options
CMakeSettings.json	Updates VS CMakeSettings variables to `OTELCPP_*` options
CMakeLists.txt	Adds `OTELCPP_*` options, subproject-friendly defaults, and legacy option forwarding
cmake/tools.cmake	Introduces helper wrappers to define options with deprecated legacy aliases
cmake/ryml.cmake	Updates install toggle variable to `OTELCPP_INSTALL`
cmake/protobuf.cmake	Updates install/utf8 validity option usage to `OTELCPP_*`
cmake/patch-imported-config.cmake	Renames testing option checks to `OTELCPP_BUILD_TESTING`
cmake/package.cmake	Renames package/tarball option to `OTELCPP_TARBALL`
cmake/opentelemetry-proto.cmake	Renames OTLP gRPC/install checks to `OTELCPP_*`
cmake/opentelemetry-build-external-component.cmake	Renames external component path option to `OTELCPP_EXTERNAL_COMPONENT_PATH`
cmake/nlohmann-json.cmake	Updates install toggle variable to `OTELCPP_INSTALL`
cmake/ms-gsl.cmake	Updates install toggle variable to `OTELCPP_INSTALL`
cmake/grpc.cmake	Updates install toggle variable to `OTELCPP_INSTALL`
cmake/curl.cmake	Updates install toggle variable to `OTELCPP_INSTALL`
ci/README.md	Updates CI documentation to reference `OTELCPP_WITH_STL`
ci/do_ci.sh	Updates CI CMake configure flags to `OTELCPP_*` options
ci/do_ci.ps1	Updates Windows CI CMake configure flags to `OTELCPP_*` options
CHANGELOG.md	Documents the CMake option renames and deprecation/precedence rules
api/test/trace/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
api/test/logs/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
api/test/common/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
api/test/CMakeLists.txt	Renames dynamic-loading option checks to `OTELCPP_SKIP_DYNAMIC_LOADING_TESTS`
api/test/baggage/CMakeLists.txt	Renames benchmark option checks to `OTELCPP_WITH_BENCHMARK`
api/CMakeLists.txt	Renames core build option checks to `OTELCPP_*` and updates related messages
.github/workflows/codeql-analysis.yml	Updates CodeQL workflow configure flags to `OTELCPP_WITH_OPENTRACING`
.github/copilot-instructions.md	Updates documented build flags to `OTELCPP_*` options

codecov · 2026-07-20T08:21:22Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.86%. Comparing base (89729e1) to head (4192a30).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4268   +/-   ##
=======================================
  Coverage   80.86%   80.86%           
=======================================
  Files         450      450           
  Lines       19216    19216           
=======================================
  Hits        15537    15537           
  Misses       3679     3679

Files with missing lines	Coverage Δ
...telemetry/ext/http/client/detail/default_factory.h	`100.00% <ø> (ø)`
ext/src/http/client/curl/http_client_curl.cc	`82.26% <ø> (ø)`

🚀 New features to boost your workflow:

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

dbarker

Thanks! Please see initial feedback below. We'll need to add some CI testing for the conversion since it can be high impact.

dbarker

Thanks for the updates. Please see some feedback and questions below.

dbarker · 2026-07-28T14:33:42Z

Thanks for the PR @owent ! Please see some feedback above. The main risk I see is that on the next release this change will trigger CMake deprecation warnings in many projects. This is communicated in the release notes well, but may still cause friction as CI workflows will need to be updated. Leaving the discuss tag on the PR to get feedback from others in the SIG meetings coming up.

lalitb · 2026-07-31T16:24:52Z

@@ -4,15 +4,20 @@
 // clang-format off


Could we move the DLL export additions and the related Windows CI corrections to a separate PR? They are not part of renaming the CMake options and materially change the Windows DLL surface. Keeping them here makes it difficult to tell whether a regression comes from option migration or from the DLL changes.

I don't known why but some CI jobs failed before, so I run make_def.ps1 to rebuild them.
Do you think we can just keep them to make all jobs passed?

lalitb · 2026-07-31T16:27:15Z

+      # The namespaced option takes precedence when both names are provided.
+      if(NOT DEFINED ${__OPTION_NAME})
+        set(__RESOLVED_DEFAULT "${__LEGACY_VALUE}")
+      elseif(NOT "${${__OPTION_NAME}}" EQUAL "${__LEGACY_VALUE}")


nit - This should use STREQUAL, not EQUAL.

Thanks, it's fixed now.

lalitb · 2026-07-31T16:30:54Z

-  set(BUILD_TESTING OFF)
-  set(BUILD_W3CTRACECONTEXT_TEST OFF)
+if(OTELCPP_WITH_API_ONLY)
+  set(OTELCPP_WITH_EXAMPLES OFF)


Should we also set WITH_EXAMPLES to OFF here?Earlier, the code copies OTELCPP_WITH_EXAMPLES into WITH_EXAMPLES. After this line, the new option can be OFF while the old option is still ON. Code using the old option would then see the wrong value.

Good point. All legacy options are also set now.

Fixes OTELCPP_BUILD_DLL and markdownlint Fixes formatting Fixes OTELCPP_BUILD_TESTING and add CHANGELOG ^ Conflicts: ^ sdk/src/CMakeLists.txt ^ sdk/src/configuration/CMakeLists.txt ^ sdk/test/CMakeLists.txt ^ Conflicts: ^ CHANGELOG.md ^ install/test/cmake/examples_test/CMakeLists.txt

Using a map to maintain legacy options Add legacy option checking Fixes zlib dep

…mappings.

…iffers. Add available conditions for otelcpp_option_flag.

owent force-pushed the new_cmake_options branch from 98a4eaa to 7f85f9a Compare July 20, 2026 07:01

owent marked this pull request as ready for review July 20, 2026 07:01

owent requested a review from a team as a code owner July 20, 2026 07:01

Copilot AI review requested due to automatic review settings July 20, 2026 07:01

Copilot started reviewing on behalf of owent July 20, 2026 07:02 View session

Copilot AI reviewed Jul 20, 2026

View reviewed changes

Comment thread CMakeLists.txt

Comment thread test_common/src/http/client/nosend/CMakeLists.txt Outdated

Comment thread tools/build.cmd Outdated

Comment thread tools/build.cmd Outdated

Comment thread exporters/otlp/CMakeLists.txt

dbarker reviewed Jul 20, 2026

View reviewed changes

Comment thread test_common/cmake/all-options-abiv1-preview.cmake

Comment thread tools/build.cmd Outdated

Comment thread CMakeSettings.json

Comment thread cmake/tools.cmake Outdated

owent force-pushed the new_cmake_options branch 2 times, most recently from 1857a05 to 953ec4b Compare July 21, 2026 17:51

ThomsonTan reviewed Jul 21, 2026

View reviewed changes

Comment thread CHANGELOG.md Outdated

dbarker reviewed Jul 22, 2026

View reviewed changes

Comment thread ci/do_ci.sh

Comment thread CMakeLists.txt Outdated

Comment thread cmake/tools.cmake

lalitb reviewed Jul 23, 2026

View reviewed changes

Comment thread cmake/tools.cmake

owent force-pushed the new_cmake_options branch 2 times, most recently from 4c5b9f4 to 74f1718 Compare July 27, 2026 13:32

dbarker added discuss To discuss in SIG meeting pr:please-review This PR is ready for review labels Jul 27, 2026

owent force-pushed the new_cmake_options branch from 74f1718 to a19dbd8 Compare July 28, 2026 06:19

dbarker approved these changes Jul 28, 2026

View reviewed changes

Comment thread ci/do_ci.sh

Comment thread CMakeLists.txt Outdated

Comment thread CHANGELOG.md Outdated

Comment thread CHANGELOG.md Outdated

Comment thread api/CMakeLists.txt

owent force-pushed the new_cmake_options branch 2 times, most recently from d373649 to d9abef6 Compare July 30, 2026 15:55

lalitb reviewed Jul 31, 2026

View reviewed changes

owent added 5 commits August 4, 2026 22:58

Fixes OTELCPP_BUILD_TESTING usage in http nosend client

01427c7

Add more export symbols

9b9bf35

Fixes dll PATH

2beb574

OTELCPP_WITH_STL should be string

ab7b4a8

Using a map to maintain legacy options Add legacy option checking Fixes zlib dep

owent added 5 commits August 4, 2026 22:58

Add document for OTELCPP_BUILD_TESTING and explicitly set all option …

b4659cf

…mappings.

Add warning message when the values of legacy option and new option d…

7fdfb60

…iffers. Add available conditions for otelcpp_option_flag.

Set the legacy option variable to the same value as the new option

9d4c4c5

Optimize document

21f42f9

Also set legacy option when update a OTELCPP_ option

4192a30

owent force-pushed the new_cmake_options branch from 01902b3 to 4192a30 Compare August 4, 2026 15:11

Uh oh!

Conversation

owent commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbarker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbarker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbarker commented Jul 28, 2026

Uh oh!

lalitb Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

owent Aug 4, 2026

Choose a reason for hiding this comment

Uh oh!

lalitb Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

owent Aug 4, 2026

Choose a reason for hiding this comment

Uh oh!

lalitb Jul 31, 2026

Choose a reason for hiding this comment

Uh oh!

owent Aug 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

owent commented Jul 19, 2026 •

edited

Loading

codecov Bot commented Jul 20, 2026 •

edited

Loading