Chore: Align/extend User Agents

[kahest]

Description

Currently, some SDKs (e.g. sentry-cocoa) don't set a user agent or just set the SDK name as user agent.
In an effort to make troubleshooting of issues more viable if only the http request headers are available (e.g. looking into LB issues), we want to add more information to the user agent:

• SDK name + version
• OS name + version

Define base and optional/additional format

Preview Give feedback

1. Add expected User-Agent format to SDK docs develop#1222
   +0

Ensure SDKs use base format

Preview Give feedback

1. Add sdk version to user agent string sentry-cocoa#3713
   Platform: Cocoa +1
   
2. Align/extend User Agent sentry-java#3274
   Platform: Android Platform: Java +2
3. React Native
4. Set user agent string (sdk name + version) sentry-native#957
   SDK parity +1
5. PHP
6. Go
7. Python
8. Ruby
9. Node (TODO, see Add expected User-Agent format to SDK docs develop#1222 (comment))
10. …add more SDKs to check here…

(Optional) Adopt optional/additional format in SDKs

Preview Give feedback

1. Add OS/runtime info to User Agent sentry-dart#1901
   Platform: Dart +1
2. …add more SDKs to implement here…

Why should we be doing this?

To make troubleshooting of issues more viable if only the http request headers are available, e.g. in incidents like INC-648

Why now?

The earlier we add at least the basic info (SDK name+version), the higher the likelihood that we have useful information available during the next incident.

RFC

No response

Slack-Channel

#inc-648

Notion Document(s)

INC-648 doc

Stakeholder(s)

INC-648, SRE

Team(s)

Mobile
Web Backend
Web Frontend (?)

[kahest]

We'll align across SDK teams what the User Agent should look like

[kahest]

PHP, Go, Python do send a user agent, format is like <sdk-name>/<sdk-version>

• https://github.com/getsentry/sentry-php/blob/master/src/HttpClient/HttpClient.php#L66
• https://github.com/getsentry/sentry-go/blob/master/transport.go#L212
• https://github.com/getsentry/sentry-python/blob/e07a128a5ff6e646421ee14bce7b5856d8d6896c/sentry_sdk/transport.py#L152

[kahest]

1. phase: all SDKs send <sdk-name>/<sdk-version>
   • most SDKs already use that format
   • some don’t set anything, some just set <sdk-name>
   • didn’t find an SDK using a different format
   • added tasks to align Mobile+adjacent SDKs, feel free to check your (Web) SDKs as well
2. phase: align on (optional) additional OS/runtime info
   • don’t need an RFC (?)
   • goal: provide a guideline on how to add that info
   • e.g. something like <sdk-name>/<sdk-version> (<device-name> <device-model>; <os-name> <os-version>; <runtime-name> <runtime-version>)
   • SDKs can implement this on case-by-case basis

[kahest]

somewhat related initiative on Ingest team: https://github.com/getsentry/team-ingest/issues/276