Support an SDK feature list to become source of truth

[bruno-garcia]

The goal is for SDKs to report their feature set via the release registry. Adding features to the registry can become part of the developer workflow (i.e add a features.yaml to the repo root and craft appends to the registry).

The goals

• Remove sheets with manually mapped feature matrix. And to have a generated page listing SDKs and the features they support.
• Remove manually maintained supported/notSupported docs guards for features.
• Define the exact version a feature was introduced. So the docs can point it out.
• Maintain the feature list in the SDK repository, next to the code, maintained by the SDK owners.

Some examples/proposed features and which SDKs support it include:

• ui.user-feedback: A UI to collect user feedback.
  • JavaScript Browser
• api.user-feedback: The API for users to fill out a user feedback received with their own UI
  • Android, Java, .NET, Apple
• api.attachment: The API to attach a file to events
  • Android, Java, .NET, Native, Python
• api.session-tracking: Can report release health through session tracking.
• api.null-annotated: For technologies with optional support for Null Safety
• auto.session-tracking: Sends session data automatically.
• options.name: Where name is the actual property name documented here.

Follow up with @PeloWriter about consuming this in the docs.

[BYK]

So getsentry/sentry#23585 essentially needs this feature to be completed.

@bruno-garcia can I assign that PR to you or is there another point person for this work?

[bruno-garcia]

We are not able to schedule this right now so it needs to stay unassigned.
Unless you want to pick it up? :)

[BYK]

We are not able to schedule this right now so it needs to stay unassigned.
Unless you want to pick it up? :)

No, thank you my plate is quite full and I don't think I have full context around this yet.

I'd rather add Status: On Hold to indicate we want to work on this but not yet to prevent it from being closed by stale bot.

[PeloWriter]

This would be very useful for our customers.

[PeloWriter]

The goal here is to programmatically answer the question "does this SDK support this feature?" which would ensure the content is correct and current. We would then also link to associated content (configuration, product guide, or third-party, for example).

Here's one example (from React Native):

Features:

• Automatic Native Crash Error Tracking (using both sentry-cocoa & sentry-android)
• Offline storage of events
• Events enriched with device data
• Autolinking
• Breadcrumbs created for outgoing http request with XHR and Fetch; UI and system events; and console logs
• Release Health tracks crash free users and sessions
• Performance Monitoring creates transactions automatically for React Navigation v4 and v5; creates spans automatically for XHR and Fetch
• Under the hood the SDK relies on our JavaScript SDK, which makes all functions available for JavaScript also available in this SDK
• On Device symbolication for JavaScript (in Debug)
• RAM bundle support
• Hermes support
• Expo support

[PeloWriter]

@bruno-garcia - can we get a definitive list of all possible features to get this started?

My suggestion (to start):

• User Feedback
• Attachments
• Minidumps
• Performance (included/custom as level of support)
• Breadcrumbs
• Release Health
• (free form - integration support)

[bruno-garcia]

I wonder if we can have a "link to examples" as a feature?
For example, in the sentry-react-native repo we'd have:

  - example-url: "https://github.com/getsentry/examples/tree/master/react-native"

[bruno-garcia]

Related prior work: getsentry/sentry-java#1527