Capture event for HTTP requests resulted in server error

[bruno-garcia]

An HTTP request can 'succeed' from the point of view of code. There wasn't a DNS failure, or a network timeout. No Exception was thrown.

Currently, in many SDKs, that means Sentry doesn't capture any events. The thinking behind it was: It's the user code that is responsible in this case. They might want to do a retry after a few seconds. If that retry works, then the first failure might not be considered an error at all.
The might want to capture the first event with level info (as opposed to error) and only once all retries are exhausted, the error level event is sent.

On the flip side, the assumption that the user code will "do the right thing" is flawed. We need to have sensible defaults, that will give value to our users out of the box. If there's some outage caused by the backend, a Mobile developer would want to be aware of that. It might come in through a series of failed HTTP requests, but the spike in events will trigger and alert, and the relevant teams can get involved to try fix the issue.

For that reason we're designing a new feature to be built-in to SDKs that have HTTP integrations. Some thoughts:

• The feature must be opt-in at first. If we turn this on by default, it's possible that a large number of errors will deplete the users quota.
• If this is a new installation of the SDK, the feature could be "on by default". We tackle that by adding the opt-in flag to the project onboarding wizard in Sentry. Same way we do 'enable performance' in SDKs.
• What status codes are we going to capture automatically? All 500-599 range? What about 4xx?
• What type of configuration will this require? What type of callbacks?

The target of this feature is any SDK with HTTP integrations. For example:

• Android OkHttp
• Java/Andrid OpenFeign
• .NET/Unity HttpMessageHandler
• UnityWebRequest
• NSURLSession
• XHR/fetch (JavaScript/React Native)
• Flutter dio
• etc..

Additionally from the event captured, we could optionally attach the request and/or response body. This is tracked here:

• Send request body for http client integrations and similar #41

Relevant PRs in Flutter

• Feat: Failed requests HTTP client sentry-dart#473
• [Dio] Replace failed http client adapter with interceptor  sentry-dart#728

Internal customer request issue: https://getsentry.atlassian.net/browse/FEEDBACK-1492

Docs

Preview Give feedback

1. Spec HTTP client errors develop#711
   +0
2. Docs for HTTP Client errors OkHttp sentry-docs#5651
   +0
3. HTTP Client errors docs for iOS sentry-docs#5702
   +0

SDKs

Preview Give feedback

1. Capture event for HTTP requests resulted in server error sentry-java#2287
   +0
2. HTTP Client errors sentry-cocoa#2308
   +0
3. chore(sample): Add Http Client Errors Example to the sample app sentry-react-native#2769
   +0
4. Support failedRequestTargets for HTTP Client errors sentry-dart#1115
   Effort: Small Impact: Medium Platform: Dart +3
   
5. Capacitor gets it via JS
6. Create a Sentry event for failed HTTP requests sentry-dotnet#2217
   Effort: Small Feature Impact: Large Platform: .NET +4
   
7. Unity - HttpClient via .NET. For UnityWebRequest, see Spans for HTTP requests - UnityWebRequest and ~HttpMessageHandler~ sentry-unity#737

Backend

Preview Give feedback

1. feat(protocol): Implement response context schema [INGEST-1661] relay#1529
   +0
   
2. Make response status_code searchable sentry#39913
   Scope: Backend Scope: Frontend +2

[marandaneto]

Adding the response metadata/body as part of the Event context would be very useful along with this feature.
Eg getsentry/sentry-dart#934
Right Now SDKs only have the built-in request metadata, but the HTTP response code sometimes might not be enough and the offending bits might be in the response metadata/body.

[bruno-garcia]

@marandaneto great point, we raised #41 and I added to the description

[marandaneto]

Removed the label for Apple because, with Swizzling, it should work for every integration.
Keeping the one for Android, it's done for OkHttp but it can be done for other integrations such as GraphQL, etc.

[marandaneto]

Pending for Dart/Flutter getsentry/sentry-dart#1115

[marandaneto]

@krystofwoldrich this has been implemented on the JS SDK, can we confirm it works for RN as well and mark the checkbox?

[krystofwoldrich]

JS SDK implementation works on RN native. Just needs to be added to the RN docs.

• chore(sample): Add Http Client Errors Example to the sample app sentry-react-native#2769

[bruno-garcia]

Capacitor will also pickup the JS implementation.
Only .NET left? cc @mattjohnsonpint

[romtsn]

Android/Java tracking here getsentry/sentry-java#2639

[mattjohnsonpint]

I think .NET was the last one - Just released today in 3.31.0. Closing this as completed. Thanks all!

[mattjohnsonpint]

Only Cocoa has good docs for this. We need to make that page common so we can all add them.
See getsentry/sentry-docs#6984