2
0

opentelemetry-proto.cmake 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. # Copyright The OpenTelemetry Authors
  2. # SPDX-License-Identifier: Apache-2.0
  3. #
  4. # The dependency on opentelemetry-proto can be provided different ways. By order
  5. # of decreasing priority, options are:
  6. #
  7. # 1 - Use a provided package
  8. #
  9. # This is useful to build opentelemetry-cpp as part of a super project.
  10. #
  11. # The super project provides the path to the opentelemetry-proto source code
  12. # using variable ${OTELCPP_PROTO_PATH}
  13. #
  14. # 2 - Search for a opentelemetry-proto git submodule
  15. #
  16. # When git submodule is used, the opentelemetry-proto code is located in:
  17. # third_party/opentelemetry-proto
  18. #
  19. # 3 - Download opentelemetry-proto from github
  20. #
  21. # Code from the required version is used, unless a specific release tag is
  22. # provided in variable ${opentelemetry-proto}
  23. #
  24. if(OTELCPP_PROTO_PATH)
  25. if(NOT EXISTS
  26. "${OTELCPP_PROTO_PATH}/opentelemetry/proto/common/v1/common.proto")
  27. message(
  28. FATAL_ERROR
  29. "OTELCPP_PROTO_PATH does not point to a opentelemetry-proto repository")
  30. endif()
  31. message(STATUS "opentelemetry-proto dependency satisfied by: external path")
  32. set(PROTO_PATH ${OTELCPP_PROTO_PATH})
  33. set(needs_proto_download FALSE)
  34. else()
  35. if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/third_party/opentelemetry-proto/.git)
  36. message(STATUS "opentelemetry-proto dependency satisfied by: git submodule")
  37. set(PROTO_PATH
  38. "${CMAKE_CURRENT_SOURCE_DIR}/third_party/opentelemetry-proto")
  39. set(needs_proto_download FALSE)
  40. else()
  41. message(
  42. STATUS "opentelemetry-proto dependency satisfied by: github download")
  43. if("${opentelemetry-proto}" STREQUAL "")
  44. file(READ "${CMAKE_CURRENT_LIST_DIR}/../third_party_release"
  45. OTELCPP_THIRD_PARTY_RELEASE_CONTENT)
  46. if(OTELCPP_THIRD_PARTY_RELEASE_CONTENT MATCHES
  47. "opentelemetry-proto=[ \\t]*([A-Za-z0-9_\\.\\-]+)")
  48. set(opentelemetry-proto "${CMAKE_MATCH_1}")
  49. else()
  50. set(opentelemetry-proto "v1.6.0")
  51. endif()
  52. unset(OTELCPP_THIRD_PARTY_RELEASE_CONTENT)
  53. endif()
  54. include(ExternalProject)
  55. ExternalProject_Add(
  56. opentelemetry-proto
  57. GIT_REPOSITORY https://github.com/open-telemetry/opentelemetry-proto.git
  58. GIT_TAG "${opentelemetry-proto}"
  59. UPDATE_COMMAND ""
  60. BUILD_COMMAND ""
  61. INSTALL_COMMAND ""
  62. CONFIGURE_COMMAND ""
  63. TEST_AFTER_INSTALL 0
  64. DOWNLOAD_NO_PROGRESS 1
  65. LOG_CONFIGURE 1
  66. LOG_BUILD 1
  67. LOG_INSTALL 1)
  68. ExternalProject_Get_Property(opentelemetry-proto INSTALL_DIR)
  69. set(PROTO_PATH "${INSTALL_DIR}/src/opentelemetry-proto")
  70. set(needs_proto_download TRUE)
  71. endif()
  72. endif()
  73. set(COMMON_PROTO "${PROTO_PATH}/opentelemetry/proto/common/v1/common.proto")
  74. set(RESOURCE_PROTO
  75. "${PROTO_PATH}/opentelemetry/proto/resource/v1/resource.proto")
  76. set(TRACE_PROTO "${PROTO_PATH}/opentelemetry/proto/trace/v1/trace.proto")
  77. set(LOGS_PROTO "${PROTO_PATH}/opentelemetry/proto/logs/v1/logs.proto")
  78. set(METRICS_PROTO "${PROTO_PATH}/opentelemetry/proto/metrics/v1/metrics.proto")
  79. set(PROFILES_PROTO
  80. "${PROTO_PATH}/opentelemetry/proto/profiles/v1development/profiles.proto")
  81. set(TRACE_SERVICE_PROTO
  82. "${PROTO_PATH}/opentelemetry/proto/collector/trace/v1/trace_service.proto")
  83. set(LOGS_SERVICE_PROTO
  84. "${PROTO_PATH}/opentelemetry/proto/collector/logs/v1/logs_service.proto")
  85. set(METRICS_SERVICE_PROTO
  86. "${PROTO_PATH}/opentelemetry/proto/collector/metrics/v1/metrics_service.proto"
  87. )
  88. set(PROFILES_SERVICE_PROTO
  89. "${PROTO_PATH}/opentelemetry/proto/collector/profiles/v1development/profiles_service.proto"
  90. )
  91. set(GENERATED_PROTOBUF_PATH
  92. "${CMAKE_BINARY_DIR}/generated/third_party/opentelemetry-proto")
  93. file(MAKE_DIRECTORY "${GENERATED_PROTOBUF_PATH}")
  94. set(COMMON_PB_CPP_FILE
  95. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/common/v1/common.pb.cc")
  96. set(COMMON_PB_H_FILE
  97. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/common/v1/common.pb.h")
  98. set(RESOURCE_PB_CPP_FILE
  99. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/resource/v1/resource.pb.cc")
  100. set(RESOURCE_PB_H_FILE
  101. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/resource/v1/resource.pb.h")
  102. set(TRACE_PB_CPP_FILE
  103. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/trace/v1/trace.pb.cc")
  104. set(TRACE_PB_H_FILE
  105. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/trace/v1/trace.pb.h")
  106. set(LOGS_PB_CPP_FILE
  107. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/logs/v1/logs.pb.cc")
  108. set(LOGS_PB_H_FILE
  109. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/logs/v1/logs.pb.h")
  110. set(METRICS_PB_CPP_FILE
  111. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/metrics/v1/metrics.pb.cc")
  112. set(METRICS_PB_H_FILE
  113. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/metrics/v1/metrics.pb.h")
  114. set(TRACE_SERVICE_PB_CPP_FILE
  115. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/trace/v1/trace_service.pb.cc"
  116. )
  117. set(TRACE_SERVICE_PB_H_FILE
  118. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/trace/v1/trace_service.pb.h"
  119. )
  120. #
  121. # Notes about the PROFILES signal: - *.proto files added in opentelemetry-proto
  122. # 1.3.0 - C++ code is generated from proto files - The generated code is not
  123. # used yet.
  124. #
  125. set(PROFILES_CPP_FILE
  126. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/profiles/v1development/profiles.pb.cc"
  127. )
  128. set(PROFILES_H_FILE
  129. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/profiles/v1development/profiles.pb.h"
  130. )
  131. set(PROFILES_SERVICE_PB_H_FILE
  132. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/profiles/v1development/profiles_service.pb.h"
  133. )
  134. set(PROFILES_SERVICE_PB_CPP_FILE
  135. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/profiles/v1development/profiles_service.pb.cc"
  136. )
  137. if(WITH_OTLP_GRPC)
  138. set(PROFILES_SERVICE_GRPC_PB_H_FILE
  139. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/profiles/v1development/profiles_service.grpc.pb.h"
  140. )
  141. set(PROFILES_SERVICE_GRPC_PB_CPP_FILE
  142. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/profiles/v1development/profiles_service.grpc.pb.cc"
  143. )
  144. endif()
  145. if(WITH_OTLP_GRPC)
  146. set(TRACE_SERVICE_GRPC_PB_CPP_FILE
  147. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/trace/v1/trace_service.grpc.pb.cc"
  148. )
  149. set(TRACE_SERVICE_GRPC_PB_H_FILE
  150. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/trace/v1/trace_service.grpc.pb.h"
  151. )
  152. endif()
  153. set(LOGS_SERVICE_PB_CPP_FILE
  154. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/logs/v1/logs_service.pb.cc"
  155. )
  156. set(LOGS_SERVICE_PB_H_FILE
  157. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/logs/v1/logs_service.pb.h"
  158. )
  159. if(WITH_OTLP_GRPC)
  160. set(LOGS_SERVICE_GRPC_PB_CPP_FILE
  161. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/logs/v1/logs_service.grpc.pb.cc"
  162. )
  163. set(LOGS_SERVICE_GRPC_PB_H_FILE
  164. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/logs/v1/logs_service.grpc.pb.h"
  165. )
  166. endif()
  167. set(METRICS_SERVICE_PB_CPP_FILE
  168. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/metrics/v1/metrics_service.pb.cc"
  169. )
  170. set(METRICS_SERVICE_PB_H_FILE
  171. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/metrics/v1/metrics_service.pb.h"
  172. )
  173. if(WITH_OTLP_GRPC)
  174. set(METRICS_SERVICE_GRPC_PB_CPP_FILE
  175. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/metrics/v1/metrics_service.grpc.pb.cc"
  176. )
  177. set(METRICS_SERVICE_GRPC_PB_H_FILE
  178. "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/collector/metrics/v1/metrics_service.grpc.pb.h"
  179. )
  180. endif()
  181. foreach(IMPORT_DIR ${PROTOBUF_IMPORT_DIRS})
  182. list(APPEND PROTOBUF_INCLUDE_FLAGS "-I${IMPORT_DIR}")
  183. endforeach()
  184. if(WITH_OTLP_GRPC)
  185. if(CMAKE_CROSSCOMPILING)
  186. find_program(gRPC_CPP_PLUGIN_EXECUTABLE grpc_cpp_plugin)
  187. else()
  188. if(TARGET gRPC::grpc_cpp_plugin)
  189. project_build_tools_get_imported_location(gRPC_CPP_PLUGIN_EXECUTABLE
  190. gRPC::grpc_cpp_plugin)
  191. else()
  192. find_program(gRPC_CPP_PLUGIN_EXECUTABLE grpc_cpp_plugin)
  193. endif()
  194. endif()
  195. message(STATUS "gRPC_CPP_PLUGIN_EXECUTABLE=${gRPC_CPP_PLUGIN_EXECUTABLE}")
  196. endif()
  197. set(PROTOBUF_COMMON_FLAGS "--proto_path=${PROTO_PATH}"
  198. "--cpp_out=${GENERATED_PROTOBUF_PATH}")
  199. # --experimental_allow_proto3_optional is available from 3.13 and be stable and
  200. # enabled by default from 3.16
  201. if(Protobuf_VERSION AND Protobuf_VERSION VERSION_LESS "3.16")
  202. list(APPEND PROTOBUF_COMMON_FLAGS "--experimental_allow_proto3_optional")
  203. elseif(PROTOBUF_VERSION AND PROTOBUF_VERSION VERSION_LESS "3.16")
  204. list(APPEND PROTOBUF_COMMON_FLAGS "--experimental_allow_proto3_optional")
  205. endif()
  206. set(PROTOBUF_GENERATED_FILES
  207. ${COMMON_PB_H_FILE}
  208. ${COMMON_PB_CPP_FILE}
  209. ${RESOURCE_PB_H_FILE}
  210. ${RESOURCE_PB_CPP_FILE}
  211. ${TRACE_PB_H_FILE}
  212. ${TRACE_PB_CPP_FILE}
  213. ${LOGS_PB_H_FILE}
  214. ${LOGS_PB_CPP_FILE}
  215. ${METRICS_PB_H_FILE}
  216. ${METRICS_PB_CPP_FILE}
  217. ${PROFILES_H_FILE}
  218. ${PROFILES_CPP_FILE}
  219. ${TRACE_SERVICE_PB_H_FILE}
  220. ${TRACE_SERVICE_PB_CPP_FILE}
  221. ${LOGS_SERVICE_PB_H_FILE}
  222. ${LOGS_SERVICE_PB_CPP_FILE}
  223. ${METRICS_SERVICE_PB_H_FILE}
  224. ${METRICS_SERVICE_PB_CPP_FILE}
  225. ${PROFILES_SERVICE_PB_H_FILE}
  226. ${PROFILES_SERVICE_PB_CPP_FILE})
  227. if(WITH_OTLP_GRPC)
  228. list(APPEND PROTOBUF_COMMON_FLAGS
  229. "--grpc_out=generate_mock_code=true:${GENERATED_PROTOBUF_PATH}"
  230. --plugin=protoc-gen-grpc="${gRPC_CPP_PLUGIN_EXECUTABLE}")
  231. list(
  232. APPEND
  233. PROTOBUF_GENERATED_FILES
  234. ${TRACE_SERVICE_GRPC_PB_H_FILE}
  235. ${TRACE_SERVICE_GRPC_PB_CPP_FILE}
  236. ${LOGS_SERVICE_GRPC_PB_H_FILE}
  237. ${LOGS_SERVICE_GRPC_PB_CPP_FILE}
  238. ${METRICS_SERVICE_GRPC_PB_H_FILE}
  239. ${METRICS_SERVICE_GRPC_PB_CPP_FILE}
  240. ${PROFILES_SERVICE_GRPC_PB_H_FILE}
  241. ${PROFILES_SERVICE_GRPC_PB_CPP_FILE})
  242. endif()
  243. set(PROTOBUF_RUN_PROTOC_COMMAND "\"${PROTOBUF_PROTOC_EXECUTABLE}\"")
  244. foreach(
  245. PROTOBUF_RUN_PROTOC_ARG
  246. ${PROTOBUF_COMMON_FLAGS}
  247. ${PROTOBUF_INCLUDE_FLAGS}
  248. ${COMMON_PROTO}
  249. ${RESOURCE_PROTO}
  250. ${TRACE_PROTO}
  251. ${LOGS_PROTO}
  252. ${METRICS_PROTO}
  253. ${PROFILES_PROTO}
  254. ${TRACE_SERVICE_PROTO}
  255. ${LOGS_SERVICE_PROTO}
  256. ${METRICS_SERVICE_PROTO}
  257. ${PROFILES_SERVICE_PROTO})
  258. set(PROTOBUF_RUN_PROTOC_COMMAND
  259. "${PROTOBUF_RUN_PROTOC_COMMAND} \"${PROTOBUF_RUN_PROTOC_ARG}\"")
  260. endforeach()
  261. add_custom_command(
  262. OUTPUT ${PROTOBUF_GENERATED_FILES}
  263. COMMAND
  264. ${PROTOBUF_PROTOC_EXECUTABLE} ${PROTOBUF_COMMON_FLAGS}
  265. ${PROTOBUF_INCLUDE_FLAGS} ${COMMON_PROTO} ${RESOURCE_PROTO} ${TRACE_PROTO}
  266. ${LOGS_PROTO} ${METRICS_PROTO} ${TRACE_SERVICE_PROTO} ${LOGS_SERVICE_PROTO}
  267. ${METRICS_SERVICE_PROTO} ${PROFILES_PROTO} ${PROFILES_SERVICE_PROTO}
  268. COMMENT "[Run]: ${PROTOBUF_RUN_PROTOC_COMMAND}"
  269. DEPENDS ${PROTOBUF_PROTOC_EXECUTABLE})
  270. unset(OTELCPP_PROTO_TARGET_OPTIONS)
  271. if(CMAKE_SYSTEM_NAME MATCHES "Windows|MinGW|WindowsStore")
  272. list(APPEND OTELCPP_PROTO_TARGET_OPTIONS STATIC)
  273. elseif(NOT DEFINED BUILD_SHARED_LIBS OR BUILD_SHARED_LIBS)
  274. list(APPEND OTELCPP_PROTO_TARGET_OPTIONS SHARED)
  275. else()
  276. list(APPEND OTELCPP_PROTO_TARGET_OPTIONS STATIC)
  277. endif()
  278. set(OPENTELEMETRY_PROTO_TARGETS opentelemetry_proto)
  279. add_library(
  280. opentelemetry_proto
  281. ${OTELCPP_PROTO_TARGET_OPTIONS}
  282. ${COMMON_PB_CPP_FILE}
  283. ${RESOURCE_PB_CPP_FILE}
  284. ${TRACE_PB_CPP_FILE}
  285. ${LOGS_PB_CPP_FILE}
  286. ${METRICS_PB_CPP_FILE}
  287. ${TRACE_SERVICE_PB_CPP_FILE}
  288. ${LOGS_SERVICE_PB_CPP_FILE}
  289. ${METRICS_SERVICE_PB_CPP_FILE})
  290. set_target_version(opentelemetry_proto)
  291. target_include_directories(
  292. opentelemetry_proto
  293. PUBLIC "$<BUILD_INTERFACE:${GENERATED_PROTOBUF_PATH}>"
  294. "$<INSTALL_INTERFACE:include>")
  295. # Disable include-what-you-use on generated code.
  296. set_target_properties(opentelemetry_proto PROPERTIES CXX_INCLUDE_WHAT_YOU_USE
  297. "")
  298. if(NOT Protobuf_INCLUDE_DIRS AND TARGET protobuf::libprotobuf)
  299. get_target_property(Protobuf_INCLUDE_DIRS protobuf::libprotobuf
  300. INTERFACE_INCLUDE_DIRECTORIES)
  301. endif()
  302. if(Protobuf_INCLUDE_DIRS)
  303. target_include_directories(
  304. opentelemetry_proto BEFORE
  305. PUBLIC "$<BUILD_INTERFACE:${Protobuf_INCLUDE_DIRS}>")
  306. endif()
  307. if(WITH_OTLP_GRPC)
  308. add_library(
  309. opentelemetry_proto_grpc
  310. ${OTELCPP_PROTO_TARGET_OPTIONS} ${TRACE_SERVICE_GRPC_PB_CPP_FILE}
  311. ${LOGS_SERVICE_GRPC_PB_CPP_FILE} ${METRICS_SERVICE_GRPC_PB_CPP_FILE})
  312. set_target_version(opentelemetry_proto_grpc)
  313. # Disable include-what-you-use on generated code.
  314. set_target_properties(opentelemetry_proto_grpc
  315. PROPERTIES CXX_INCLUDE_WHAT_YOU_USE "")
  316. list(APPEND OPENTELEMETRY_PROTO_TARGETS opentelemetry_proto_grpc)
  317. target_link_libraries(opentelemetry_proto_grpc PUBLIC opentelemetry_proto)
  318. get_target_property(grpc_lib_type gRPC::grpc++ TYPE)
  319. if(grpc_lib_type STREQUAL "SHARED_LIBRARY")
  320. target_link_libraries(opentelemetry_proto_grpc PUBLIC gRPC::grpc++)
  321. endif()
  322. set_target_properties(opentelemetry_proto_grpc PROPERTIES EXPORT_NAME
  323. proto_grpc)
  324. patch_protobuf_targets(opentelemetry_proto_grpc)
  325. get_target_property(GRPC_INCLUDE_DIRECTORY gRPC::grpc++
  326. INTERFACE_INCLUDE_DIRECTORIES)
  327. if(GRPC_INCLUDE_DIRECTORY)
  328. target_include_directories(
  329. opentelemetry_proto_grpc BEFORE
  330. PUBLIC "$<BUILD_INTERFACE:${GRPC_INCLUDE_DIRECTORY}>")
  331. endif()
  332. endif()
  333. if(needs_proto_download)
  334. add_dependencies(opentelemetry_proto opentelemetry-proto)
  335. endif()
  336. set_target_properties(opentelemetry_proto PROPERTIES EXPORT_NAME proto)
  337. patch_protobuf_targets(opentelemetry_proto)
  338. if(OPENTELEMETRY_INSTALL)
  339. install(
  340. DIRECTORY ${GENERATED_PROTOBUF_PATH}/opentelemetry
  341. DESTINATION include
  342. COMPONENT exporters_otlp_common
  343. FILES_MATCHING
  344. PATTERN "*.h")
  345. endif()
  346. if(TARGET protobuf::libprotobuf)
  347. target_link_libraries(opentelemetry_proto PUBLIC protobuf::libprotobuf)
  348. else() # cmake 3.8 or lower
  349. target_link_libraries(opentelemetry_proto PUBLIC ${Protobuf_LIBRARIES})
  350. endif()
  351. # this is needed on some older grcp versions specifically conan recipe for grpc/1.54.3
  352. if(WITH_OTLP_GRPC)
  353. if(TARGET absl::synchronization)
  354. target_link_libraries(opentelemetry_proto_grpc
  355. PUBLIC "$<BUILD_INTERFACE:absl::synchronization>")
  356. endif()
  357. endif()
  358. if(BUILD_SHARED_LIBS)
  359. foreach(proto_target ${OPENTELEMETRY_PROTO_TARGETS})
  360. set_property(TARGET ${proto_target} PROPERTY POSITION_INDEPENDENT_CODE ON)
  361. endforeach()
  362. endif()