Skip to content

Commit 7845429

Browse files
authored
Merge branch 'main' into cmake_find_or_fetch_prometheus_cpp
2 parents b769e25 + a1e6011 commit 7845429

File tree

10 files changed

+154
-171
lines changed

10 files changed

+154
-171
lines changed

.github/workflows/cmake_install.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ jobs:
215215
run: ./ci/do_ci.sh cmake.opentracing_shim.install.test
216216

217217
ubuntu_2404_conan_latest:
218-
name: Ubuntu 24.04 conan latest versions cxx17 (static libs)
218+
name: Ubuntu 24.04 conan latest versions cxx17 (static libs - opentracing shim)
219219
runs-on: ubuntu-24.04
220220
env:
221221
INSTALL_TEST_DIR: '/home/runner/install_test'
@@ -248,6 +248,8 @@ jobs:
248248
run: |
249249
export PKG_CONFIG_PATH=$INSTALL_TEST_DIR/lib/pkgconfig:$PKG_CONFIG_PATH
250250
./ci/verify_packages.sh
251+
- name: Run OpenTracing Shim Test
252+
run: ./ci/do_ci.sh cmake.opentracing_shim.install.test
251253

252254
macos_14_conan_stable:
253255
name: macOS 14 conan stable versions cxx17 (static libs)

CMakeLists.txt

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,6 @@ project(opentelemetry-cpp)
3636
# Mark variables as used so cmake doesn't complain about them
3737
mark_as_advanced(CMAKE_TOOLCHAIN_FILE)
3838

39-
# Note: CMAKE_FIND_PACKAGE_PREFER_CONFIG requires cmake 3.15. Prefer cmake
40-
# CONFIG search mode to find dependencies. This is important to properly find
41-
# protobuf versions 3.22.0 and above due to the abseil-cpp dependency.
42-
set(CMAKE_FIND_PACKAGE_PREFER_CONFIG TRUE)
43-
4439
# Don't use customized cmake modules if vcpkg is used to resolve dependence.
4540
if(NOT DEFINED CMAKE_TOOLCHAIN_FILE)
4641
list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/modules/")
@@ -79,10 +74,6 @@ if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
7974
CACHE STRING "")
8075
endif()
8176

82-
if(VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
83-
include("${VCPKG_CHAINLOAD_TOOLCHAIN_FILE}")
84-
endif()
85-
8677
option(WITH_ABI_VERSION_1 "ABI version 1" ON)
8778
option(WITH_ABI_VERSION_2 "EXPERIMENTAL: ABI version 2 preview" OFF)
8879

@@ -455,6 +446,14 @@ if((NOT WITH_API_ONLY) AND USE_NLOHMANN_JSON)
455446
include("${opentelemetry-cpp_SOURCE_DIR}/cmake/nlohmann-json.cmake")
456447
endif()
457448

449+
#
450+
# Do we need OpenTracing ?
451+
#
452+
453+
if(WITH_OPENTRACING)
454+
include("${opentelemetry-cpp_SOURCE_DIR}/cmake/opentracing-cpp.cmake")
455+
endif()
456+
458457
if(OTELCPP_MAINTAINER_MODE)
459458
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
460459
message(STATUS "Building with gcc in maintainer mode.")
@@ -654,13 +653,19 @@ if(ZLIB_FOUND)
654653
message(STATUS "ZLIB: ${ZLIB_VERSION}")
655654
endif()
656655
if(USE_NLOHMANN_JSON)
657-
message(STATUS "nlohmann-json: ${nlohmann_json_VERSION}")
656+
message(
657+
STATUS "nlohmann-json: ${nlohmann_json_VERSION} (${nlohmann_json_PROVIDER})"
658+
)
658659
endif()
659660
if(WITH_PROMETHEUS)
660661
message(
661662
STATUS
662663
"prometheus-cpp: ${prometheus-cpp_VERSION} (${prometheus-cpp_PROVIDER})")
663664
endif()
665+
if(WITH_OPENTRACING)
666+
message(
667+
STATUS "opentracing-cpp: ${OpenTracing_VERSION} (${OpenTracing_PROVIDER})")
668+
endif()
664669
message(STATUS "---------------------------------------------")
665670

666671
include("${opentelemetry-cpp_SOURCE_DIR}/cmake/otel-install-functions.cmake")
@@ -684,30 +689,6 @@ endif()
684689
add_subdirectory(api)
685690

686691
if(WITH_OPENTRACING)
687-
find_package(OpenTracing CONFIG QUIET)
688-
if(NOT OpenTracing_FOUND)
689-
set(OPENTRACING_DIR "third_party/opentracing-cpp")
690-
message(STATUS "Trying to use local ${OPENTRACING_DIR} from submodule")
691-
if(EXISTS "${PROJECT_SOURCE_DIR}/${OPENTRACING_DIR}/.git")
692-
set(SAVED_BUILD_TESTING ${BUILD_TESTING})
693-
set(BUILD_TESTING OFF)
694-
set(SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE
695-
${CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
696-
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "")
697-
add_subdirectory(${OPENTRACING_DIR})
698-
set(BUILD_TESTING ${SAVED_BUILD_TESTING})
699-
set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE
700-
${SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
701-
else()
702-
message(
703-
FATAL_ERROR
704-
"\nopentracing-cpp package was not found. Please either provide it manually or clone with submodules. "
705-
"To initialize, fetch and checkout any nested submodules, you can use the following command:\n"
706-
"git submodule update --init --recursive")
707-
endif()
708-
else()
709-
message(STATUS "Using external opentracing-cpp")
710-
endif()
711692
add_subdirectory(opentracing-shim)
712693
endif()
713694

cmake/nlohmann-json.cmake

Lines changed: 39 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,48 @@
11
# Copyright The OpenTelemetry Authors
22
# SPDX-License-Identifier: Apache-2.0
33

4-
#
5-
# The dependency on nlohmann_json can be provided different ways. By order of
6-
# decreasing priority, options are:
7-
#
8-
# 1 - Search for a nlohmann_json package
9-
#
10-
# Packages installed on the local machine are used if found.
11-
#
12-
# The nlohmann_json dependency is not installed, as it already is.
13-
#
14-
# 2 - Search for a nlohmann_json git submodule
15-
#
16-
# When git submodule is used, the nlohmann_json code is located in:
17-
# third_party/nlohmann-json
18-
#
19-
# The nlohmann_json dependency is installed, by building the sub directory with
20-
# JSON_Install=ON
21-
#
22-
# 3 - Download nlohmann_json from github
23-
#
24-
# Code from the development branch is used, unless a specific release tag is
25-
# provided in variable ${nlohmann-json}
26-
#
27-
# The nlohmann_json dependency is installed, by building the downloaded code
28-
# with JSON_Install=ON
29-
#
4+
# Import nlohmann_json target (nlohmann_json::nlohmann_json).
5+
# 1. Find an installed nlohmann-json package
6+
# 2. Use FetchContent to build nlohmann-json from a git submodule
7+
# 3. Use FetchContent to fetch and build nlohmann-json from GitHub
308

31-
# nlohmann_json package is required for most SDK build configurations
32-
find_package(nlohmann_json QUIET)
33-
set(nlohmann_json_clone FALSE)
34-
if(nlohmann_json_FOUND)
35-
message(STATUS "nlohmann::json dependency satisfied by: package")
36-
elseif(TARGET nlohmann_json)
37-
message(STATUS "nlohmann::json is already added as a CMake target!")
38-
elseif(EXISTS ${PROJECT_SOURCE_DIR}/.git
39-
AND EXISTS
40-
${PROJECT_SOURCE_DIR}/third_party/nlohmann-json/CMakeLists.txt)
41-
message(STATUS "nlohmann::json dependency satisfied by: git submodule")
42-
set(JSON_BuildTests
43-
OFF
44-
CACHE INTERNAL "")
45-
set(JSON_Install
46-
ON
47-
CACHE INTERNAL "")
48-
# This option allows to link nlohmann_json::nlohmann_json target
49-
add_subdirectory(${PROJECT_SOURCE_DIR}/third_party/nlohmann-json)
50-
# This option allows to add header to include directories
51-
include_directories(
52-
${PROJECT_SOURCE_DIR}/third_party/nlohmann-json/single_include)
53-
else()
54-
if("${nlohmann-json}" STREQUAL "")
55-
set(nlohmann-json "develop")
9+
find_package(nlohmann_json CONFIG QUIET)
10+
set(nlohmann_json_PROVIDER "find_package")
11+
12+
if(NOT nlohmann_json_FOUND)
13+
set(_NLOHMANN_JSON_SUBMODULE_DIR "${opentelemetry-cpp_SOURCE_DIR}/third_party/nlohmann-json")
14+
if(EXISTS "${_NLOHMANN_JSON_SUBMODULE_DIR}/.git")
15+
FetchContent_Declare(
16+
"nlohmann_json"
17+
SOURCE_DIR "${_NLOHMANN_JSON_SUBMODULE_DIR}"
18+
)
19+
set(nlohmann_json_PROVIDER "fetch_source")
20+
else()
21+
FetchContent_Declare(
22+
"nlohmann_json"
23+
GIT_REPOSITORY "https://github.com/nlohmann/json.git"
24+
GIT_TAG "${nlohmann-json_GIT_TAG}"
25+
)
26+
set(nlohmann_json_PROVIDER "fetch_repository")
5627
endif()
57-
message(STATUS "nlohmann::json dependency satisfied by: github download")
58-
set(nlohmann_json_clone TRUE)
59-
include(ExternalProject)
60-
ExternalProject_Add(
61-
nlohmann_json_download
62-
PREFIX third_party
63-
GIT_REPOSITORY https://github.com/nlohmann/json.git
64-
GIT_TAG "${nlohmann-json_GIT_TAG}"
65-
UPDATE_COMMAND ""
66-
CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
67-
-DJSON_BuildTests=OFF -DJSON_Install=ON
68-
-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
69-
TEST_AFTER_INSTALL 0
70-
DOWNLOAD_NO_PROGRESS 1
71-
LOG_CONFIGURE 1
72-
LOG_BUILD 1
73-
LOG_INSTALL 1)
7428

75-
ExternalProject_Get_Property(nlohmann_json_download INSTALL_DIR)
76-
set(NLOHMANN_JSON_INCLUDE_DIR
77-
${INSTALL_DIR}/src/nlohmann_json_download/single_include)
78-
add_library(nlohmann_json_ INTERFACE)
79-
target_include_directories(
80-
nlohmann_json_ INTERFACE "$<BUILD_INTERFACE:${NLOHMANN_JSON_INCLUDE_DIR}>"
81-
"$<INSTALL_INTERFACE:include>")
82-
add_dependencies(nlohmann_json_ nlohmann_json_download)
83-
add_library(nlohmann_json::nlohmann_json ALIAS nlohmann_json_)
29+
set(JSON_BuildTests OFF CACHE BOOL "" FORCE)
30+
set(JSON_Install ${OPENTELEMETRY_INSTALL} CACHE BOOL "" FORCE)
31+
set(JSON_MultipleHeaders OFF CACHE BOOL "" FORCE)
32+
33+
FetchContent_MakeAvailable(nlohmann_json)
34+
35+
# Set the nlohmann_json_VERSION variable from the git tag.
36+
string(REGEX REPLACE "^v([0-9]+\\.[0-9]+\\.[0-9]+)$" "\\1" nlohmann_json_VERSION "${nlohmann-json_GIT_TAG}")
8437

85-
if(OPENTELEMETRY_INSTALL)
86-
install(
87-
TARGETS nlohmann_json_
88-
EXPORT "${PROJECT_NAME}-third_party_nlohmann_json_target"
89-
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
90-
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
91-
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
92-
COMPONENT third_party_nlohmann_json)
38+
#Disable iwyu and clang-tidy
39+
if(TARGET nlohmann_json)
40+
set_target_properties(nlohmann_json PROPERTIES CXX_INCLUDE_WHAT_YOU_USE ""
41+
CXX_CLANG_TIDY "")
9342
endif()
9443
endif()
44+
45+
if(NOT TARGET nlohmann_json::nlohmann_json)
46+
message(FATAL_ERROR "A required nlohmann_json target (nlohmann_json::nlohmann_json) was not imported")
47+
endif()
48+

cmake/opentracing-cpp.cmake

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Copyright The OpenTelemetry Authors
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
find_package(OpenTracing CONFIG QUIET)
5+
set(OpenTracing_PROVIDER "find_package")
6+
7+
if(NOT OpenTracing_FOUND)
8+
set(_OPENTRACING_SUBMODULE_DIR "${opentelemetry-cpp_SOURCE_DIR}/third_party/opentracing-cpp")
9+
if(EXISTS "${_OPENTRACING_SUBMODULE_DIR}/.git")
10+
FetchContent_Declare(
11+
"opentracing"
12+
SOURCE_DIR "${_OPENTRACING_SUBMODULE_DIR}"
13+
)
14+
set(OpenTracing_PROVIDER "fetch_source")
15+
else()
16+
FetchContent_Declare(
17+
"opentracing"
18+
GIT_REPOSITORY "https://github.com/opentracing/opentracing-cpp.git"
19+
GIT_TAG "${opentracing-cpp_GIT_TAG}"
20+
)
21+
set(OpenTracing_PROVIDER "fetch_repository")
22+
endif()
23+
24+
# OpenTracing uses the BUILD_TESTING variable directly and we must force the cached value to OFF.
25+
# save the current state of BUILD_TESTING
26+
if(DEFINED BUILD_TESTING)
27+
set(_SAVED_BUILD_TESTING ${BUILD_TESTING})
28+
endif()
29+
30+
# Set the cache variables for the opentracing build
31+
set(BUILD_TESTING OFF CACHE BOOL "" FORCE)
32+
set(BUILD_MOCKTRACER OFF CACHE BOOL "" FORCE)
33+
34+
FetchContent_MakeAvailable(opentracing)
35+
36+
# Restore the saved state of BUILD_TESTING
37+
if(DEFINED _SAVED_BUILD_TESTING)
38+
set(BUILD_TESTING ${_SAVED_BUILD_TESTING} CACHE BOOL "" FORCE)
39+
else()
40+
unset(BUILD_TESTING CACHE)
41+
endif()
42+
43+
# Patch the opentracing targets to set missing includes, add namespaced alias targets, disable iwyu and clang-tidy.
44+
foreach(_target opentracing opentracing-static)
45+
if(TARGET ${_target})
46+
# Add missing include directories
47+
target_include_directories(${_target} PUBLIC
48+
"$<BUILD_INTERFACE:${opentracing_SOURCE_DIR}/include>"
49+
"$<BUILD_INTERFACE:${opentracing_SOURCE_DIR}/3rd_party/include>"
50+
"$<BUILD_INTERFACE:${opentracing_BINARY_DIR}/include>"
51+
)
52+
# Disable CXX_INCLUDE_WHAT_YOU_USE and CXX_CLANG_TIDY
53+
set_target_properties(${_target}
54+
PROPERTIES CXX_INCLUDE_WHAT_YOU_USE "" CXX_CLANG_TIDY "")
55+
# Create alias targets
56+
if(NOT TARGET OpenTracing::${_target})
57+
add_library(OpenTracing::${_target} ALIAS ${_target})
58+
endif()
59+
endif()
60+
endforeach()
61+
62+
# Set the OpenTracing_VERSION variable from the git tag.
63+
string(REGEX REPLACE "^v([0-9]+\\.[0-9]+\\.[0-9]+)$" "\\1" OpenTracing_VERSION "${opentracing-cpp_GIT_TAG}")
64+
endif(NOT OpenTracing_FOUND)
65+
66+
if(NOT TARGET OpenTracing::opentracing AND NOT TARGET OpenTracing::opentracing-static)
67+
message(FATAL_ERROR "No OpenTracing targets (OpenTracing::opentracing or OpenTracing::opentracing-static) were imported")
68+
endif()

exporters/etw/CMakeLists.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,6 @@ target_link_libraries(
1515
opentelemetry_exporter_etw INTERFACE opentelemetry_api opentelemetry_trace
1616
nlohmann_json::nlohmann_json)
1717
target_link_libraries(opentelemetry_exporter_etw INTERFACE opentelemetry_logs)
18-
if(nlohmann_json_clone)
19-
add_dependencies(opentelemetry_exporter_etw nlohmann_json::nlohmann_json)
20-
endif()
2118

2219
otel_add_component(
2320
COMPONENT

exporters/otlp/CMakeLists.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,6 @@ if(WITH_OTLP_HTTP)
151151
"$<BUILD_INTERFACE:nlohmann_json::nlohmann_json>"
152152
"$<INSTALL_INTERFACE:opentelemetry_http_client_curl>")
153153

154-
if(nlohmann_json_clone)
155-
add_dependencies(opentelemetry_exporter_otlp_http_client
156-
nlohmann_json::nlohmann_json)
157-
endif()
158154
target_include_directories(
159155
opentelemetry_exporter_otlp_http_client
160156
PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>"
@@ -228,10 +224,6 @@ if(WITH_OTLP_FILE)
228224
PUBLIC opentelemetry_sdk opentelemetry_common
229225
PRIVATE opentelemetry_proto $<BUILD_INTERFACE:nlohmann_json::nlohmann_json>)
230226

231-
if(nlohmann_json_clone)
232-
add_dependencies(opentelemetry_exporter_otlp_file_client
233-
nlohmann_json::nlohmann_json)
234-
endif()
235227
target_include_directories(
236228
opentelemetry_exporter_otlp_file_client
237229
PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>"

ext/test/w3c_tracecontext_http_test_server/CMakeLists.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@ target_link_libraries(
77
PRIVATE ${CMAKE_THREAD_LIBS_INIT} opentelemetry_trace
88
opentelemetry_http_client_curl opentelemetry_exporter_ostream_span
99
${CURL_LIBRARIES} nlohmann_json::nlohmann_json)
10-
if(nlohmann_json_clone)
11-
add_dependencies(w3c_tracecontext_http_test_server
12-
nlohmann_json::nlohmann_json)
13-
endif()

install/conan/conanfile_latest.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ protobuf/*:shared=False
2525
abseil/*:fPIC=True
2626
abseil/*:shared=False
2727
opentracing-cpp/*:fPIC=True
28-
opentracing-cpp/*:shared=True
28+
opentracing-cpp/*:shared=False
2929
pcre2/*:with_bzip2=False
3030

3131
[test_requires]

install/test/cmake/component_tests/shims_opentracing/CMakeLists.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@ project(opentelemetry-cpp-shims_opentracing-install-test LANGUAGES CXX)
66

77
find_package(opentelemetry-cpp REQUIRED COMPONENTS shims_opentracing)
88

9-
if(NOT TARGET OpenTracing::opentracing)
10-
message(FATAL_ERROR "OpenTracing::opentracing target not found")
9+
if(NOT TARGET OpenTracing::opentracing AND NOT TARGET
10+
OpenTracing::opentracing-static)
11+
message(
12+
FATAL_ERROR
13+
"A required OpenTracing target (OpenTracing::opentracing or OpenTracing::opentracing-static) was not imported"
14+
)
1115
endif()
1216

1317
find_package(GTest CONFIG REQUIRED)

0 commit comments

Comments
 (0)