Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
SDK Philosophy - Write less code (#1316)
Browse files Browse the repository at this point in the history
* SDK Philosophy - Write less code

Another addition for our SDK Philosophy

* Update philosophy.mdx

* Update src/docs/sdk/philosophy.mdx

Co-authored-by: Abhijeet Prasad <aprasad@sentry.io>

---------

Co-authored-by: Michi Hoffmann <cleptric@users.noreply.github.com>
Co-authored-by: Abhijeet Prasad <aprasad@sentry.io>
  • Loading branch information
3 people authored Jun 25, 2024
1 parent e09172f commit a2e89e1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/docs/sdk/philosophy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,7 @@ Please check <Link to="/sdk/data-handling">Data Handling</Link> for more detail.
## Don’t forget the big picture

Being correct is important but even more important is doing the right thing. Yes, we are building libraries and with that comes much responsibility. But in the end, we build a product that should solve a problem users have in their application. This principle relates to many other things mentioned on this page - but most importantly, it should act as a reminder that we only succeed if we manage to solve a problem end-to-end.

## Write less code

The role of an SDK is to instrument the user's application, collect context around the event types we want to capture, and send event data with useful context to Sentry. We should avoid extensive business logic within the SDK that transforms this data as it can get complex, hard to maintain and makes permanent changes to the wire format we send events. We should aim to have data collected by the SDK be as raw as possible. We have more flexibility and control on the server to manipulate the data more effectively.

0 comments on commit a2e89e1

Please sign in to comment.