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

opentelemetry-cpp 1.16.0 #175322

Merged
merged 2 commits into from
Jun 21, 2024
Merged

opentelemetry-cpp 1.16.0 #175322

merged 2 commits into from
Jun 21, 2024

Conversation

BrewTestBot
Copy link
Member

Created by brew bump


Created with brew bump-formula-pr.

release notes
## v1.16.0 release

Release of core packages

  • opentelemetry-api
  • opentelemetry-sdk

and exporter packages:

  • opentelemetry-exporter-otlp (gRPC + HTTP/JSON)
  • opentelemetry-exporter-prometheus

What's Changed

Important changes

  • [API/SDK] Provider cleanup
    #2664
    • Before this fix:
      • The API class opentelemetry::trace::Tracer exposed methods such
        as ForceFlush(), ForceFlushWithMicroseconds(), Close()
        and CloseWithMicroseconds().
      • These methods are meant to be used when configuring the SDK,
        and should not be part of the API. Exposing them was an oversight.
      • Two of these methods are virtual, and therefore part of the ABI.
    • After this fix:
      • In OPENTELEMETRY_ABI_VERSION_NO 1, nothing is changed,
        because removing this code would break the ABI.
      • In OPENTELEMETRY_ABI_VERSION_NO 2, these methods are moved
        from the API to the SDK. This is a breaking change for ABI version 2,
        which is still experimental.
    • In all cases, instrumenting an application should not
      invoke flush or close on a tracer, do not use these methods.

Breaking changes

  • [API/SDK] Provider cleanup
    #2664
    • Before this fix:
      • SDK factory methods such as:
        • opentelemetry::sdk::trace::TracerProviderFactory::Create()
        • opentelemetry::sdk::metrics::MeterProviderFactory::Create()
        • opentelemetry::sdk::logs::LoggerProviderFactory::Create()
        • opentelemetry::sdk::logs::EventLoggerProviderFactory::Create()
          returned an API object (opentelemetry::trace::TracerProvider)
          to the caller.
    • After this fix, these methods return an SDK level object
      (opentelemetry::sdk::trace::TracerProvider) to the caller.
    • Returning an SDK object is necessary for the application to
      cleanup and invoke SDK level methods, such as ForceFlush(),
      on a provider.
    • The application code that configures the SDK, by calling
      the various provider factories, may need adjustment.
    • All the examples have been updated, and in particular no
      longer perform static_cast do convert an API object to an SDK object.
      Please refer to examples for guidance on how to adjust.
    • If adjusting application code is impractical,
      an alternate and temporary solution is to build with option
      WITH_DEPRECATED_SDK_FACTORY=ON in CMake.
    • Option WITH_DEPRECATED_SDK_FACTORY=ON will allow to build code
      without application changes, posponing changes for later.
    • WITH_DEPRECATED_SDK_FACTORY=ON is temporary, only to provide
      an easier migration path. Expect this flag to be removed,
      as early as by the next release.

Notes on experimental features

  • #2372
    introduced MeterProvider::SetExemplar() which accepts an
    ExemplarFilterType enumeration with kAlwaysOff, kAlwaysOn and
    kTraceBased.

New Contributors

Full Changelog: open-telemetry/opentelemetry-cpp@v1.15.0...v1.16.0

@github-actions github-actions bot added bump-formula-pr PR was created using `brew bump-formula-pr` boost Boost use is a significant feature of the PR or issue labels Jun 21, 2024
Copy link
Contributor

🤖 An automated task has requested bottles to be published to this PR.

@github-actions github-actions bot added the CI-published-bottle-commits The commits for the built bottles have been pushed to the PR branch. label Jun 21, 2024
@BrewTestBot BrewTestBot enabled auto-merge June 21, 2024 20:08
@BrewTestBot BrewTestBot added this pull request to the merge queue Jun 21, 2024
Merged via the queue into master with commit bf59d52 Jun 21, 2024
14 checks passed
@BrewTestBot BrewTestBot deleted the bump-opentelemetry-cpp-1.16.0 branch June 21, 2024 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
boost Boost use is a significant feature of the PR or issue bump-formula-pr PR was created using `brew bump-formula-pr` CI-published-bottle-commits The commits for the built bottles have been pushed to the PR branch.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants