4.0.0 GA - Performance Monitoring

[bruno-garcia]

4.0.0 will GA the Java Performance API. That means both Android and Spring will have it, but spring includes also auto instrumentation.

Java main API:

• Add environment and release to all transactions environment and other fields are missing for transactions #1147 (PR: Fix: Set release and environment on Transactions. #1152)
• Delete the preview note (PR: Java SDK 4.0 Docs update sentry-docs#2833)
• Document connecting errors and spans (PR: Java SDK 4.0 Docs update sentry-docs#2833)
• Document changes in the transport (the new apache transport ApacheHttpClientTransportFactory auto-configuration. #1143) (PR: Java SDK 4.0 Docs update sentry-docs#2833)
• Document changes in the API once (Polish Performance API #1165) and (Fix potential NPE by separating transaction contexts. #1164) are merged, Fix Java/Kotlin code snippets for Performance API sentry-docs#2912
• traces-sampler-as-sampler is different for Java and Kotlin snippets traces-sampler-as-sampler is different for Java and Kotlin snippets sentry-docs#2850

Android:

• Alpha: Add docs for manual instrumentation (Make sure Kotlin samples are there) Performance docs for Android sentry-docs#2851
• Alpha: Verify it works properly with offline caching (always-on on Android)
• On the samples in this repo, opt-in for performance with random sampling 1.0.

Spring:

• New Transport for Java backend: Java Server Transport #1097 (PR: High throughput transport implementation #1114, Add non blocking Apache HttpClient 5 based Transport. #1136)
• Docs to point users to opt-in to the Apache transport (PR: Java SDK 4.0 Docs update sentry-docs#2833)
• Add support to datasource-proxy and documentation (PR: Database queries tracing with datasource-proxy. #1095)
• Performance for Spring (non-boot) (PR Simplify Spring integration #1188)
• Performance docs for Spring instrumentation (currently only Spring Boot has it)

Discussions

• Clarify differences in API to align with .NET (and help build Flutter and iOS that come next): Performance API follow up sentry-dotnet#663 (PR: Polish Performance API #1165)
• Address the developer docs points: Improve transaction & span docs develop#221
• Scope's transaction field Document Scope's transaction field develop#246
• API suggestion for finishing a transaction/span API suggestion for finishing a transaction/span develop#245
• Contexts.trace Document Contexts.trace develop#244
• Sampling decision Document where/when the Sample decision should be made develop#243
• Document default values for 'Span.op' on auto instrumented SDKs Document default values for 'Span.op' on auto instrumented SDKs develop#247
• TracesSampler returns null (idea from .NOT) TracesSamplerCallback allows returning a nullable Double #1204

[maciejwalkowiak]

Discuss new API to take callback and wrap the whole transaction (to be discussed on the 11th of Jan)

The proposal for this API:

Sentry.runTransaction("name", tx -> {
  // some code
});

Where runTransaction method would look like:

public static void runTransaction(String transactionName, Consumer<ITransaction> runnable) {
  ITransaction transaction = startTransaction(transactionName);
  try {
    runnable.accept(transaction);
    transaction.setStatus(SpanStatus.OK);
  } catch (Throwable e) {
    transaction.setThrowable(e);
    transaction.setStatus(SpanStatus.INTERNAL_ERROR);
  } finally {
    transaction.finish();
  }
}

With such simple API we don't give a an option to set different status on error, but it can be a good enough tradeoff.

[bruno-garcia]

Do we bind the transaction to the scope to integrations can find it? Seems like that could be done here, if we push a scope in there so it has its own isolated scope.

That would work on Java but not on Android (global hub mode).

We can add an overload that takes a configuration object later if we want to extend this API but I think by default we should push a scope and bind the transaction to it.

Which remind me that we bind it automatically and that needs to be removed, or at least configurable, and default false.

[maciejwalkowiak]

We can add an overload that takes a configuration object later if we want to extend this API but I think by default we should push a scope and bind the transaction to it.

Which remind me that we bind it automatically and that needs to be removed, or at least configurable, and default false.

Please elaborate. Currently when startTransaction is called we do stack.peek().getScope().setTransaction(transaction);, making this configurable on the startTransaction method level would make the API clumsy as we would need to add bunch of new overloaded methods.

[marandaneto]

@bruno-garcia can we close #1130 and use only this one? checkbox items will keep out of sync, I prefer a single source of truth.

Or to remove the Android items from here

[bruno-garcia]

Oh I just did it but realized that was for an alpha.

@marandaneto I'll just add the 2 points from that issue in here with a note (for the alpha) so we can focus on those for the next milestone (Android Performance Alpha release)

[marandaneto]

Oh I just did it but realized that was for an alpha.

@marandaneto I'll just add the 2 points from that issue in here with a note (for the alpha) so we can focus on those for the next milestone (Android Performance Alpha release)

urgh, yeah also missed the alpha subtitle, thx

[marandaneto]

@bruno-garcia what do you mean by Opt-in to the Java/Kotlin samples for performance? wouldn't it be the same as https://sentry-docs-git-feat-android-performance.sentry.dev/platforms/android/performance/ ?

[bruno-garcia]

@marandaneto I reworded it: Let's turn performance monitoring on on all our samples in this repo?

[maciejwalkowiak]

Clarify differences in API to align with .NET (and help build Flutter and iOS that come next): getsentry/sentry-dotnet#663 (PR: #1165)

Is there anything more we should clarify?

[bruno-garcia]

Clarify differences in API to align with .NET (and help build Flutter and iOS that come next): getsentry/sentry-dotnet#663 (PR: #1165)

Is there anything more we should clarify?

Checked the check box 🥳 we're close eh

[bruno-garcia]

We've GA'ed and everything that was required is done. Follow up tasks linked can be done on their own now.

[dashed]

@bruno-garcia 🎉