[BUILD] Allow shared `opentelemetry_proto` on non-Windows platform. #2097

owent · 2023-04-15T10:52:47Z

Fixes #2096
Fixes #2139

Changes

Please provide a brief description of the changes here.

Allow build shared opentelemetry_proto on non-Windows platform.
Add opentelemetry_proto_grpc which contains generated grpc files (Which depends gRPC) to make OTLP Http exporter do not depends gRPC when otel-cpp is built as dynamic libraries.

Sorry for push a wrong repo by mistake before, I have moved the fix_2096 branch into my fork.

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

codecov · 2023-04-15T11:06:10Z

Codecov Report

Merging #2097 (bfbe345) into main (c9f14e9) will increase coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2097      +/-   ##
==========================================
+ Coverage   87.15%   87.17%   +0.03%     
==========================================
  Files         166      166              
  Lines        4777     4777              
==========================================
+ Hits         4163     4164       +1     
+ Misses        614      613       -1

see 1 file with indirect coverage changes

Signed-off-by: WenTao Ou <[email protected]>

Signed-off-by: owent <[email protected]>

ThomsonTan · 2023-05-03T18:05:55Z

cmake/opentelemetry-proto.cmake

+if(WITH_OTLP_GRPC)
+  if(WITH_ABSEIL)
+    find_package(absl CONFIG)
+    if(TARGET absl::synchronization)


Is the target absl::synchronization optional, or error out if it doesn't exist?

I'm not sure if absl::synchronization can be turn off.I'm not familar with abseil-cpp.

Just curious the motive of this change - was there any build error with WITH_ABSEIL?

lalitb · 2023-05-09T03:54:53Z

cmake/opentelemetry-proto.cmake

+  list(APPEND OTELCPP_PROTO_TARGET_OPTIONS STATIC)
+endif()
+
+list(APPEND OTELCPP_PROTO_TARGET_OPTIONS)


Not sure if I am missing something, but how are we using OTELCPP_PROTO_TARGET_OPTIONS

Sorry, it's a mistake after merging.

lalitb · 2023-05-09T04:04:38Z

@owent As I understand, this PR adds two new shared libs - opentelemetry_proto and opentelemetry_proto_grpc. And these shared libraries would be used by otlp_recordable, otlp_http_client and otlp_grpc_client targets. How much reduction in total otel lib size we are seeing with this change ? As this could be a breaking change if users are hardcoding the required otel libraries in their build, we should have a sufficient total size reduction to reason for a breaking change.

…ing. Signed-off-by: owent <[email protected]>

owent · 2023-05-09T06:22:00Z

@owent As I understand, this PR adds two new shared libs - opentelemetry_proto and opentelemetry_proto_grpc. And these shared libraries would be used by otlp_recordable, otlp_http_client and otlp_grpc_client targets. How much reduction in total otel lib size we are seeing with this change ? As this could be a breaking change if users are hardcoding the required otel libraries in their build, we should have a sufficient total size reduction to reason for a breaking change.

Spliting opentelemetry_proto into opentelemetry_proto and opentelemetry_proto_grpc is used to avoid to depend on gRPC when users only use OTLP HTTP exporters. The generated gRPC sources in opentelemetry_proto_grpc depend gRPC.
If users use both OTLP HTTP and gRPC exporters, I think the total size will not decreased(at lease in my tests it do not decrease), but we can allow users use only one of them to reduce the final package size.

lalitb · 2023-05-09T18:07:34Z

CHANGELOG.md

@@ -19,6 +19,8 @@ Increment the:
  [#2123](https://github.com/open-telemetry/opentelemetry-cpp/pull/2123)
 * [BUILD] Build break with old curl, macro CURL_VERSION_BITS unknown
  [#2102](https://github.com/open-telemetry/opentelemetry-cpp/pull/2102)
+* [BUILD] Allow build shared opentelemetry_proto on non-Windows platform.


Do you think we should mentioned this PR potential breaking change here in changelog, as we have are introducing a new library?

Do you think we should mentioned this PR potential breaking change here in changelog, as we have are introducing a new library?
Sure, the changelog is added now.

Just curious the motive of this change - was there any build error with WITH_ABSEIL?

Yes, the related CI job is here https://github.com/open-telemetry/opentelemetry-cpp/actions/runs/4707416429/jobs/8349260349 .

lalitb · 2023-05-09T18:11:51Z

cmake/opentelemetry-proto.cmake

+if(WITH_OTLP_GRPC)
+  if(WITH_ABSEIL)
+    find_package(absl CONFIG)
+    if(TARGET absl::synchronization)


Just curious the motive of this change - was there any build error with WITH_ABSEIL?

Signed-off-by: owent <[email protected]>

lalitb

LGTM. Thanks

Signed-off-by: owent <[email protected]>

marcalff

LGTM, thanks for the fix for 2139 as well.

owent requested a review from a team April 15, 2023 10:52

owent force-pushed the fix_2096 branch from 8c6f07c to 69763b5 Compare April 16, 2023 14:25

owent added 6 commits April 20, 2023 11:28

Allow build shared opentelemetry_proto on non-Windows platform.

67bf8c7

Signed-off-by: WenTao Ou <[email protected]>

Fix proto linking.

ea7d86c

Signed-off-by: WenTao Ou <[email protected]>

Fix gRPC linking on ELF ABI.

c5ea45d

Signed-off-by: WenTao Ou <[email protected]>

Add opentelemetry_proto_grpc to make OTLP HTTP do not depends gRPC.

643fdfb

Signed-off-by: WenTao Ou <[email protected]>

Fix set_property for proto targets.

69860c8

Signed-off-by: owent <[email protected]>

gRPC should be private linked.

fb1d6c1

Signed-off-by: owent <[email protected]>

owent force-pushed the fix_2096 branch from 0176116 to fb1d6c1 Compare April 20, 2023 03:30

Merge branch 'main' into fix_2096

d1185f6

owent mentioned this pull request May 3, 2023

[BUILD] Add missing target dependencies #2128

Merged

3 tasks

ThomsonTan reviewed May 3, 2023

View reviewed changes

owent and others added 2 commits May 7, 2023 17:51

Merge remote-tracking branch 'opentelemetry/main' into fix_2096

57001c2

Merge branch 'main' into fix_2096

0a18f46

lalitb reviewed May 9, 2023

View reviewed changes

Correct the usage mistake of OTELCPP_PROTO_TARGET_OPTIONS when merg…

679b8cf

…ing. Signed-off-by: owent <[email protected]>

lalitb reviewed May 9, 2023

View reviewed changes

Add break changelog for proto_grpc

9ab0f59

Signed-off-by: owent <[email protected]>

owent force-pushed the fix_2096 branch from c2e9a92 to 9ab0f59 Compare May 10, 2023 03:21

lalitb approved these changes May 10, 2023

View reviewed changes

Merge branch 'main' into fix_2096

3eaf4d7

owent mentioned this pull request May 17, 2023

[BUILD] OTLP GRPC exporter fails to build with non default GRPC install #2139

Closed

Include gRPC's include directories for opentelemetry_proto_grpc.

bfbe345

Signed-off-by: owent <[email protected]>

marcalff approved these changes May 17, 2023

View reviewed changes

marcalff merged commit 23dfc20 into open-telemetry:main May 17, 2023

marcalff changed the title ~~Allow build shared opentelemetry_proto on non-Windows platform.~~ [BUILD] Allow shared opentelemetry_proto on non-Windows platform. May 23, 2023

owent deleted the fix_2096 branch May 27, 2023 06:11

chenrui333 mentioned this pull request May 28, 2023

opentelemetry-cpp 1.9.1 Homebrew/homebrew-core#132204

Closed

amachado-pie mentioned this pull request Oct 30, 2023

opentelemetry-cpp: add 1.10.0 conan-io/conan-center-index#18647

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUILD] Allow shared `opentelemetry_proto` on non-Windows platform. #2097

[BUILD] Allow shared `opentelemetry_proto` on non-Windows platform. #2097

owent commented Apr 15, 2023 •

edited

Loading

codecov bot commented Apr 15, 2023 •

edited

Loading

ThomsonTan May 3, 2023

owent May 4, 2023

lalitb May 9, 2023

lalitb May 9, 2023

owent May 9, 2023

lalitb commented May 9, 2023 •

edited

Loading

owent commented May 9, 2023

lalitb May 9, 2023

owent May 10, 2023

lalitb May 9, 2023

lalitb left a comment

marcalff left a comment

[BUILD] Allow shared opentelemetry_proto on non-Windows platform. #2097

[BUILD] Allow shared opentelemetry_proto on non-Windows platform. #2097

Conversation

owent commented Apr 15, 2023 • edited Loading

Changes

codecov bot commented Apr 15, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lalitb commented May 9, 2023 • edited Loading

owent commented May 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lalitb left a comment

Choose a reason for hiding this comment

marcalff left a comment

Choose a reason for hiding this comment

[BUILD] Allow shared `opentelemetry_proto` on non-Windows platform. #2097

[BUILD] Allow shared `opentelemetry_proto` on non-Windows platform. #2097

owent commented Apr 15, 2023 •

edited

Loading

codecov bot commented Apr 15, 2023 •

edited

Loading

lalitb commented May 9, 2023 •

edited

Loading