Use SentryOptions.sdkInfo instead of SentryMeta

[philipphofmann]

Description

The SDK currently uses both SentryOptions.sdkInfo and SentryMeta for creating the sdkInfo.

To fix this, we have to add new initializers to SentryEnvelopeHeader and SentryEnvelope, requiring the SDKInfo. On Java, we also have to pass in the SDKInfo as a parameter see https://github.com/getsentry/sentry-java/blob/9f1af1c68c58570a731a65289183107d3c4f90d5/sentry/src/main/java/io/sentry/SentryEnvelope.java#L36-L78

We can't get rid of the initializers using SentryMeta, because this would be a breaking change. I think we have two options:

Option A
Marking these initializers as deprecated, adding new ones requiring SDKInfo as a parameter remove them in 8.x.x., but this would bubble up to all initializers of SentryEnvelopes.

Option B
Use SentrySDK.currentHub for getting the options in SentryEnvelope and SentryEnvelopeHeader, and mark the initializers as deprecated in 8.x.x and remove them in 9.x.x. Even if someone would use multiple clients with different options, they most likely will use the same SDKInfo.

This came up in #1853

[brustolin]

I believe we could inject SentryOptions into DependencyContainer to use it across the project

[philipphofmann]

I believe we could inject SentryOptions into DependencyContainer to use it across the project

This won't work if you use multiple hubs and not the static API.

[philipphofmann]

Why is SDKInfo even on the options? Is there a use case for users to change this? One requirement for changing the SDKInfo is for our hybrid SDKs, but they could use a private API instead to override the SentryMeta. @bruno-garcia, @marandaneto are we missing something?

[bruno-garcia]

I believe we could inject SentryOptions into DependencyContainer to use it across the project

This won't work if you use multiple hubs and not the static API.

is Hub public here? I thought multiple Hubs wasn't something we supported.

Happy to use a private API to set it, for as long as we can override the value from things like Unity and possibly more SDKs going forward

[philipphofmann]

is Hub public here? I thought multiple Hubs wasn't something we supported.

Yes, it's public so that you could use multiple hubs. I guess the majority though uses the static API.

[marandaneto]

Why is SDKInfo even on the options? Is there a use case for users to change this? One requirement for changing the SDKInfo is for our hybrid SDKs, but they could use a private API instead to override the SentryMeta. @bruno-garcia, @marandaneto are we missing something?

It's needed for either Hybrid SDKs or when an SDK consists of multiple packages, eg.
By default options.sdkVersion will point to sentry, but if you're using the sentry-spring-boot-starter package, you actually want to overwrite the options.sdkVersion to sentry-spring-boot-starter and adding the sdkVersion to the options was the easiest way, I don't think there are more use cases.

[brustolin]

This information should not be available to the end-user in the options.
We need to add a way in the private Hybrid class (PrivateSentrySDKOnly) to change the SDKInfo,
this information needs to be a unique source of truth in a static class.
Mark the SDKInfo option as deprecated.
Remember to communicate with Unity team (@bitsandfoxes)