Project: Normalize `http.response.status_code` for Metrics & Alerts

smeubank commented 1 year ago

Project Board

https://github.com/orgs/getsentry/projects/130/views/1

Description

http.response.status_code is set in different places in different SDKs which creates some problems in processing for metrics extraction and then

https://www.notion.so/sentry/Expand-Metrics-for-Alerts-cdfa32d7624e498b8246c3f131f753f1#17480955e2fb4407b619b9236bc2723a

Requirements

Confirm where it is stored today for ingest to know as-is
Need status code number (standard HTTP status code 2xx, 4xx, 5xx, etc)
The SDK should never on it's own set this as a tag - as this adds expense due to indexing being based on tags
the location of storage needs to be in a standard location based on span schema
- follow existing standard in develop docs
- of not starfish has a workstream to standardize span schema https://github.com/getsentry/rfcs/pull/89

List of all SDKs and how they store HTTP status code now:

https://www.notion.so/sentry/Inquiry-HTTP-Status-Code-ca90c050fb76428b8ce07a5e9e954767

### Web Frontend SDKs
- [ ] https://github.com/getsentry/sentry-javascript/issues/8692
- [ ] https://github.com/getsentry/sentry-javascript/issues/8365

### Web Backend SDKs
- [ ] https://github.com/getsentry/sentry-go/issues/667
- [ ] https://github.com/getsentry/sentry-dotnet/issues/2471
- [ ] https://github.com/getsentry/sentry-ruby/issues/2065
- [ ] https://github.com/getsentry/sentry-java/issues/2835
- [ ] https://github.com/getsentry/sentry-python/issues/2099
- [ ] https://github.com/getsentry/sentry-python/issues/2289
- [ ] https://github.com/getsentry/sentry-php/issues/1564

### Mobile SDKs
- [ ] https://github.com/getsentry/team-mobile/issues/121

olksdr commented 1 year ago

@smeubank thanks for creating an issue for this!

I know we already talked about this, but just to mention one more time. It would be great to gather the information from the SDKs where those http status code are set now. It will give us opportunity to do some of the normalizations on the server-side and support also old SDKs till the standard place is used.

\cc @matejminar @ale-cota

antonpirker commented 1 year ago

Hey I have now changed the description from http.status to http.status_code because this is mentioned in the Notion page and this is how it is called in Python SDK.

antonpirker commented 1 year ago

I added a list of all SDKs to collect how the HTTP status code is stored now. (in description above) and also linking here: https://www.notion.so/sentry/Inquiry-HTTP-Status-Code-ca90c050fb76428b8ce07a5e9e954767

mattjohnsonpint commented 1 year ago

Is this for status codes from HTTP client outbound calls, or from HTTP server inbound calls, or both?

AbhiPrasad commented 1 year ago

Is this for status codes from HTTP client outbound calls, or from HTTP server inbound calls, or both?

I think we should write it for both, given we are actively thinking about indexing span info w/ Starfish.

cleptric commented 1 year ago

Unsure about removing the creation of tags for the status code in SDKs that do so today.

antonpirker commented 1 year ago

Maybe users created alerts or dashboards for the http status code tag. Maybe we should check how many users did stuff like that.

Or we always just keep the tag and also set the status in the span data too, to make it backwards compatible.

getsentry / team-sdks