Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUILD] Fix default value of OPENTELEMETRY_INSTALL_default #2062

Merged
merged 2 commits into from
Mar 17, 2023

Conversation

owent
Copy link
Member

@owent owent commented Mar 16, 2023

Fixes #2061

Changes

The default value of OPENTELEMETRY_INSTALL_default should be ON when otel-cpp in on top level.

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

@owent owent requested a review from a team March 16, 2023 06:40
@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Merging #2062 (3a793bc) into main (211d9c9) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2062   +/-   ##
=======================================
  Coverage   87.32%   87.32%           
=======================================
  Files         166      166           
  Lines        4723     4723           
=======================================
  Hits         4124     4124           
  Misses        599      599           

Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

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

What about simplifying to:

option(OPENTELEMETRY_INSTALL "Whether to install opentelemetry targets" ON)

and let users override the value to avoid installation if they want to, based on their own logic when used in super projects.

@owent
Copy link
Member Author

owent commented Mar 16, 2023

What about simplifying to:

option(OPENTELEMETRY_INSTALL "Whether to install opentelemetry targets" ON)

and let users override the value to avoid installation if they want to, based on their own logic when used in super projects.

In my opnion, it's easier for users to enable the installation when it's the top level, because most libraries will include it too by default.
Both ways are fine to me.

Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

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

Both solutions:

  • patch as proposed
  • simple always ON option by default

looks good to me.

Waiting on input from other reviewers, ok to merge in both cases.

@lalitb
Copy link
Member

lalitb commented Mar 16, 2023

Existing approach in this PR looks good to me, this is also similar with what is followed by gRPC and nlohmanm-json when used through super projects.

@lalitb
Copy link
Member

lalitb commented Mar 16, 2023

@owent - Can you resolve the CHANGELOG.md conflict, will enable to merge this PR.

@esigo esigo 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 Mar 16, 2023
Signed-off-by: owent <admin@owent.net>
Signed-off-by: owent <admin@owent.net>
@owent
Copy link
Member Author

owent commented Mar 17, 2023

@owent - Can you resolve the CHANGELOG.md conflict, will enable to merge this PR.

Done nad thanks.

@lalitb lalitb enabled auto-merge (squash) March 17, 2023 02:16
@lalitb lalitb merged commit 5ccf493 into open-telemetry:main Mar 17, 2023
@owent owent deleted the fix_2061 branch March 20, 2023 02:52
@marcalff marcalff changed the title Fix default value of OPENTELEMETRY_INSTALL_default. [BUILD] Fix default value of OPENTELEMETRY_INSTALL_default Apr 12, 2023
ays7 added a commit to ays7/opentelemetry-cpp that referenced this pull request May 18, 2023
* commit '7887d32da60f54984a597abccbb0c883f3a51649': (82 commits)
  [RELEASE] Release version 1.9.0 (open-telemetry#2091)
  Use sdk_start_ts for MetricData start_ts for instruments having cumulative aggregation temporality. (open-telemetry#2086)
  [SEMANTIC CONVENTIONS] Upgrade to version 1.20.0 (open-telemetry#2088)
  [EXPORTER] Add OTLP HTTP SSL support (open-telemetry#1793)
  Make Windows build environment parallel (open-telemetry#2080)
  make some hints (open-telemetry#2078)
  Make some targets parallel in CI pipeline (open-telemetry#2076)
  [Metrics SDK] Implement Forceflush for Periodic Metric Reader (open-telemetry#2064)
  Upgraded semantic conventions to 1.19.0 (open-telemetry#2017)
  Bump actions/stale from 7 to 8 (open-telemetry#2070)
  Include directory path added for Zipkin exporter example (open-telemetry#2069)
  Ignore more warning of generated protobuf files than not included in `-Wall` and `-Wextra` (open-telemetry#2067)
  Add `ForceFlush` for all `LogRecordExporter`s and `SpanExporter`s. (open-telemetry#2000)
  Remove unused 'alerting' section from prometheus.yml in examples (open-telemetry#2055)
  Clean warnings in ETW exporters (open-telemetry#2063)
  Fix default value of `OPENTELEMETRY_INSTALL_default`. (open-telemetry#2062)
  [EXPORTER] GRPC endpoint scheme should take precedence over OTEL_EXPORTER_OTLP_TRACES_INSECURE (open-telemetry#2060)
  Fix view names in Prometheus example (open-telemetry#2034)
  Fix some docs typo (open-telemetry#2057)
  Checking indices before dereference (open-telemetry#2040)
  ...

# Conflicts:
#	exporters/ostream/CMakeLists.txt
#	sdk/src/metrics/state/metric_collector.cc
#	sdk/src/metrics/state/temporal_metric_storage.cc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

OPENTELEMETRY_INSTALL_default should be ON when oetl-cpp is on top level.
4 participants