|
1 | 1 | # Changelog |
2 | 2 |
|
| 3 | +## Unreleased |
| 4 | + |
| 5 | +### Breaking Changes |
| 6 | + |
| 7 | +- `sentry-android-okhttp` has been removed in favor of `sentry-okhttp`, removing android dependency from the module ([#3510](https://github.com/getsentry/sentry-java/pull/3510)) |
| 8 | + |
| 9 | +### Fixes |
| 10 | + |
| 11 | +- Support spans that are split into multiple batches ([#3539](https://github.com/getsentry/sentry-java/pull/3539)) |
| 12 | + - When spans belonging to a single transaction were split into multiple batches for SpanExporter, we did not add all spans because the isSpanTooOld check wasn't inverted. |
| 13 | +- Parse and use `send-default-pii` and `max-request-body-size` from `sentry.properties` ([#3534](https://github.com/getsentry/sentry-java/pull/3534)) |
| 14 | +- `span.startChild` now uses `.makeCurrent()` by default ([#3544](https://github.com/getsentry/sentry-java/pull/3544)) |
| 15 | + - This caused an issue where the span tree wasn't correct because some spans were not added to their direct parent |
| 16 | +- Partially fix bootstrap class loading ([#3543](https://github.com/getsentry/sentry-java/pull/3543)) |
| 17 | + - There was a problem with two separate Sentry `Scopes` being active inside each OpenTelemetry `Context` due to using context keys from more than one class loader. |
| 18 | + |
| 19 | +## 8.0.0-alpha.2 |
| 20 | + |
| 21 | +### Behavioural Changes |
| 22 | + |
| 23 | +- (Android) The JNI layer for sentry-native has now been moved from sentry-java to sentry-native ([#3189](https://github.com/getsentry/sentry-java/pull/3189)) |
| 24 | + - This now includes prefab support for sentry-native, allowing you to link and access the sentry-native API within your native app code |
| 25 | + - Checkout the `sentry-samples/sentry-samples-android` example on how to configure CMake and consume `sentry.h` |
| 26 | + |
| 27 | +### Features |
| 28 | + |
| 29 | +- Our `sentry-opentelemetry-agent` has been completely reworked and now plays nicely with the rest of the Java SDK |
| 30 | + - You may also want to give this new agent a try even if you haven't used OpenTelemetry (with Sentry) before. It offers support for [many more libraries and frameworks](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md), improving on our trace propagation, `Scopes` (used to be `Hub`) propagation as well as performance instrumentation (i.e. more spans). |
| 31 | + - If you are using a framework we did not support before and currently resort to manual instrumentation, please give the agent a try. See [here for a list of supported libraries, frameworks and application servers](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md). |
| 32 | + - NOTE: Not all features have been implemented yet for the OpenTelemetry agent. Features of note that are not working yet: |
| 33 | + - Metrics |
| 34 | + - Measurements |
| 35 | + - `forceFinish` on transaction |
| 36 | + - `scheduleFinish` on transaction |
| 37 | + - see [#3436](https://github.com/getsentry/sentry-java/issues/3436) for a more up-to-date list of features we have (not) implemented |
| 38 | + - Please see "Installing `sentry-opentelemetry-agent`" for more details on how to set up the agent. |
| 39 | + - What's new about the Agent |
| 40 | + - When the OpenTelemetry Agent is used, Sentry API creates OpenTelemetry spans under the hood, handing back a wrapper object which bridges the gap between traditional Sentry API and OpenTelemetry. We might be replacing some of the Sentry performance API in the future. |
| 41 | + - This is achieved by configuring the SDK to use `OtelSpanFactory` instead of `DefaultSpanFactory` which is done automatically by the auto init of the Java Agent. |
| 42 | + - OpenTelemetry spans are now only turned into Sentry spans when they are finished so they can be sent to the Sentry server. |
| 43 | + - Now registers an OpenTelemetry `Sampler` which uses Sentry sampling configuration |
| 44 | + - Other Performance integrations automatically stop creating spans to avoid duplicate spans |
| 45 | + - The Sentry SDK now makes use of OpenTelemetry `Context` for storing Sentry `Scopes` (which is similar to what used to be called `Hub`) and thus relies on OpenTelemetry for `Context` propagation. |
| 46 | + - Classes used for the previous version of our OpenTelemetry support have been deprecated but can still be used manually. We're not planning to keep the old agent around in favor of less complexity in the SDK. |
| 47 | +- Add `ignoredSpanOrigins` option for ignoring spans coming from certain integrations |
| 48 | + - We pre-configure this to ignore Performance instrumentation for Spring and other integrations when using our OpenTelemetry Agent to avoid duplicate spans |
| 49 | +- Add data fetching environment hint to breadcrumb for GraphQL (#3413) ([#3431](https://github.com/getsentry/sentry-java/pull/3431)) |
| 50 | + |
| 51 | +### Fixes |
| 52 | + |
| 53 | +- `TracesSampler` is now only created once in `SentryOptions` instead of creating a new one for every `Hub` (which is now `Scopes`). This means we're now creating fewer `SecureRandom` instances. |
| 54 | +- Move onFinishCallback before span or transaction is finished ([#3459](https://github.com/getsentry/sentry-java/pull/3459)) |
| 55 | +- Add timestamp when a profile starts ([#3442](https://github.com/getsentry/sentry-java/pull/3442)) |
| 56 | +- Move fragment auto span finish to onFragmentStarted ([#3424](https://github.com/getsentry/sentry-java/pull/3424)) |
| 57 | +- Remove profiling timeout logic and disable profiling on API 21 ([#3478](https://github.com/getsentry/sentry-java/pull/3478)) |
| 58 | +- Properly reset metric flush flag on metric emission ([#3493](https://github.com/getsentry/sentry-java/pull/3493)) |
| 59 | + |
| 60 | +### Migration Guide / Deprecations |
| 61 | + |
| 62 | +- Classes used for the previous version of the Sentry OpenTelemetry Java Agent have been deprecated (`SentrySpanProcessor`, `SentryPropagator`, `OpenTelemetryLinkErrorEventProcessor`) |
| 63 | +- Sentry OpenTelemetry Java Agent has been reworked and now allows you to manually create spans using Sentry API as well. |
| 64 | +- Please see "Installing `sentry-opentelemetry-agent`" for more details on how to set up the agent. |
| 65 | + |
| 66 | +### Installing `sentry-opentelemetry-agent` |
| 67 | + |
| 68 | +#### Upgrading from a previous agent |
| 69 | +If you've been using the previous version of `sentry-opentelemetry-agent`, simply replace the agent JAR with the [latest release](https://central.sonatype.com/artifact/io.sentry/sentry-opentelemetry-agent?smo=true) and start your application. That should be it. |
| 70 | + |
| 71 | +#### New to the agent |
| 72 | +If you've not been using OpenTelemetry before, you can add `sentry-opentelemetry-agent` to your setup by downloading the latest release and using it when starting up your application |
| 73 | + - `SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent-x.x.x.jar -jar your-application.jar` |
| 74 | + - Please use `sentry.properties` or environment variables to configure the SDK as the agent is now in charge of initializing the SDK and options coming from things like logging integrations or our Spring Boot integration will not take effect. |
| 75 | + - You may find the [docs page](https://docs.sentry.io/platforms/java/tracing/instrumentation/opentelemetry/#using-sentry-opentelemetry-agent-with-auto-initialization) useful. While we haven't updated it yet to reflect the changes described here, the section about using the agent with auto init should still be valid. |
| 76 | + |
| 77 | +If you want to skip auto initialization of the SDK performed by the agent, please follow the steps above and set the environment variable `SENTRY_AUTO_INIT` to `false` then add the following to your `Sentry.init`: |
| 78 | + |
| 79 | +``` |
| 80 | +Sentry.init(options -> { |
| 81 | + options.setDsn("https://[email protected]/1801383"); |
| 82 | + OpenTelemetryUtil.applyOpenTelemetryOptions(options); |
| 83 | + ... |
| 84 | +}); |
| 85 | +``` |
| 86 | + |
| 87 | +If you're using our Spring (Boot) integration with auto init, use the following: |
| 88 | +``` |
| 89 | +@Bean |
| 90 | +Sentry.OptionsConfiguration<SentryOptions> optionsConfiguration() { |
| 91 | + return (options) -> { |
| 92 | + OpenTelemetryUtil.applyOpenTelemetryOptions(options); |
| 93 | + }; |
| 94 | +} |
| 95 | +``` |
| 96 | + |
| 97 | +### Dependencies |
| 98 | + |
| 99 | +- Bump Native SDK from v0.7.0 to v0.7.5 ([#3441](https://github.com/getsentry/sentry-java/pull/3189)) |
| 100 | + - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#075) |
| 101 | + - [diff](https://github.com/getsentry/sentry-native/compare/0.7.0...0.7.5) |
| 102 | + |
| 103 | +## 8.0.0-alpha.1 |
| 104 | + |
| 105 | +Version 8 of the Sentry Android/Java SDK brings a variety of features and fixes. The most notable changes are: |
| 106 | + |
| 107 | +- New `Scope` types have been introduced, see "Behavioural Changes" for more details. |
| 108 | +- Lifecycle tokens have been introduced to manage `Scope` lifecycle, see "Behavioural Changes" for more details. |
| 109 | +- `Hub` has been replaced by `Scopes` |
| 110 | + |
| 111 | +### Behavioural Changes |
| 112 | + |
| 113 | +- We're introducing some new `Scope` types in the SDK, allowing for better control over what data is attached where. Previously there was a stack of scopes that was pushed and popped. Instead we now fork scopes for a given lifecycle and then restore the previous scopes. Since `Hub` is gone, it is also never cloned anymore. Separation of data now happens through the different scope types while making it easier to manipulate exactly what you need without having to attach data at the right time to have it apply where wanted. |
| 114 | + - Global scope is attached to all events created by the SDK. It can also be modified before `Sentry.init` has been called. It can be manipulated using `Sentry.configureScope(ScopeType.GLOBAL, (scope) -> { ... })`. |
| 115 | + - Isolation scope can be used e.g. to attach data to all events that come up while handling an incoming request. It can also be used for other isolation purposes. It can be manipulated using `Sentry.configureScope(ScopeType.ISOLATION, (scope) -> { ... })`. The SDK automatically forks isolation scope in certain cases like incoming requests, CRON jobs, Spring `@Async` and more. |
| 116 | + - Current scope is forked often and data added to it is only added to events that are created while this scope is active. Data is also passed on to newly forked child scopes but not to parents. |
| 117 | +- `Sentry.popScope` has been deprecated, please call `.close()` on the token returned by `Sentry.pushScope` instead or use it in a way described in more detail in "Migration Guide". |
| 118 | +- We have chosen a default scope that is used for `Sentry.configureScope()` as well as API like `Sentry.setTag()` |
| 119 | + - For Android the type defaults to `CURRENT` scope |
| 120 | + - For Backend and other JVM applicatons it defaults to `ISOLATION` scope |
| 121 | +- Event processors on `Scope` can now be ordered by overriding the `getOrder` method on implementations of `EventProcessor`. NOTE: This order only applies to event processors on `Scope` but not `SentryOptions` at the moment. Feel free to request this if you need it. |
| 122 | +- `Hub` is deprecated in favor of `Scopes`, alongside some `Hub` relevant APIs. More details can be found in the "Migration Guide" section. |
| 123 | + |
| 124 | +### Breaking Changes |
| 125 | + |
| 126 | +- `Contexts` no longer extends `ConcurrentHashMap`, instead we offer a selected set of methods. |
| 127 | + |
| 128 | +### Migration Guide / Deprecations |
| 129 | + |
| 130 | +- `Hub` has been deprecated, we're replacing the following: |
| 131 | + - `IHub` has been replaced by `IScopes`, however you should be able to simply pass `IHub` instances to code expecting `IScopes`, allowing for an easier migration. |
| 132 | + - `HubAdapter.getInstance()` has been replaced by `ScopesAdapter.getInstance()` |
| 133 | + - The `.clone()` method on `IHub`/`IScopes` has been deprecated, please use `.pushScope()` or `.pushIsolationScope()` instead |
| 134 | + - Some internal methods like `.getCurrentHub()` and `.setCurrentHub()` have also been replaced. |
| 135 | +- `Sentry.popScope` has been replaced by calling `.close()` on the token returned by `Sentry.pushScope()` and `Sentry.pushIsolationScope()`. The token can also be used in a `try` block like this: |
| 136 | + |
| 137 | +``` |
| 138 | +try (final @NotNull ISentryLifecycleToken ignored = Sentry.pushScope()) { |
| 139 | + // this block has its separate current scope |
| 140 | +} |
| 141 | +``` |
| 142 | + |
| 143 | +as well as: |
| 144 | + |
| 145 | + |
| 146 | +``` |
| 147 | +try (final @NotNull ISentryLifecycleToken ignored = Sentry.pushIsolationScope()) { |
| 148 | + // this block has its separate isolation scope |
| 149 | +} |
| 150 | +``` |
| 151 | + |
| 152 | +You may also use `LifecycleHelper.close(token)`, e.g. in case you need to pass the token around for closing later. |
| 153 | + |
| 154 | +### Features |
| 155 | + |
| 156 | +- Report exceptions returned by Throwable.getSuppressed() to Sentry as exception groups ([#3396] https://github.com/getsentry/sentry-java/pull/3396) |
| 157 | + |
3 | 158 | ## 7.11.0 |
4 | 159 |
|
5 | 160 | ### Features |
|
0 commit comments