✨ [RUM-2902] Add error causes to context when logging an error

[N-Boutaib]

Motivation

This PR addresses this issue in order to add an error's causes when logging it.

Changes

Add flattened error causes to the error's context when logging it.

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.

[BenoitZugmeyer]

PR looks good, but I think we should collect error causes for other errors collected by the Logs SDK:

• console.error instrumentation ->

  browser-sdk/packages/logs/src/domain/console/consoleCollection.ts

  Line 32 in ed48184

  stack: log.stack,

• runtime errors ->

  browser-sdk/packages/logs/src/domain/runtimeError/runtimeErrorCollection.ts

  Line 31 in ed48184

  stack: rawError.stack,

I think that's it?

Maybe a function to format a rawError into log error.* properties could be nice, so we have cause, fingerprint and kind properly defined everywhere as well.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f6f76a1) 92.78% compared to head (c8609ec) 92.78%.
Report is 14 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2602   +/-   ##
=======================================
  Coverage   92.78%   92.78%           
=======================================
  Files         235      235           
  Lines        6794     6795    +1     
  Branches     1489     1490    +1     
=======================================
+ Hits         6304     6305    +1     
  Misses        490      490           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[amortemousque]

💭 thought: ‏ It's not directly related to the PR but looking at how we collect errors in Logs it seems we have some discrepancies:

• error.fingerprint only set in console.error but not in logger.error
• error.message only set in logger.error but not in other error collections
• error.kind not set in console.error

It could be nice to have a more centralize ways to format Error. You could introduce something in this PR like mentioned by @BenoitZugmeyer (cf comment) or maybe in a following PR :)

[N-Boutaib]

/merge

[dd-devflow]

🚂 MergeQueue

Pull request added to the queue.

This build is going to start soon! (estimated merge in less than 33m)

Use /merge -c to cancel this operation!