Ref: Make hints Map<String, Object> instead of only Object

[marandaneto]

📜 Description

Ref: Make hints Map<String, Object> instead of only Object

💡 Motivation and Context

Closes #1558

💚 How did you test it?

Adapted unit tests.

📝 Checklist

• I reviewed the submitted code
• I added tests to verify the changes
• I updated the docs if needed
• No breaking changes

🔮 Next steps

[codecov-commenter]

Codecov Report

Merging #1929 (ff8d394) into 6.x.x (e948a50) will increase coverage by 0.04%.
The diff coverage is 69.37%.

@@             Coverage Diff              @@
##              6.x.x    #1929      +/-   ##
============================================
+ Coverage     80.48%   80.52%   +0.04%     
- Complexity     2907     2910       +3     
============================================
  Files           213      214       +1     
  Lines         10776    10851      +75     
  Branches       1427     1432       +5     
============================================
+ Hits           8673     8738      +65     
- Misses         1587     1595       +8     
- Partials        516      518       +2     

Impacted Files	Coverage Δ
...vlet/SentryRequestHttpServletRequestProcessor.java	94.73% <ø> (ø)
...ring/SentryRequestHttpServletRequestProcessor.java	100.00% <ø> (ø)
...racing/SentrySpanClientHttpRequestInterceptor.java	0.00% <0.00%> (ø)
.../sentry/DuplicateEventDetectionEventProcessor.java	100.00% <ø> (ø)
sentry/src/main/java/io/sentry/EventProcessor.java	50.00% <ø> (ø)
sentry/src/main/java/io/sentry/HubAdapter.java	5.00% <ø> (ø)
sentry/src/main/java/io/sentry/IHub.java	86.36% <ø> (ø)
sentry/src/main/java/io/sentry/ISentryClient.java	85.71% <ø> (ø)
...ntry/src/main/java/io/sentry/NoOpSentryClient.java	60.00% <0.00%> (ø)
sentry/src/main/java/io/sentry/Scope.java	97.02% <ø> (ø)
... and 36 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e948a50...ff8d394. Read the comment docs.

[bruno-garcia]

I skimmed through it and the only question I have is: Do we plan on documenting these hint keys so folks can find/use them in beforeSend/eventProcessors?

Perhaps it'd be best to have them available in public static String's and use some sort of prefixing. To avoid conflict as more hints are added and to be easier to understand what the value represents.

[marandaneto]

I skimmed through it and the only question I have is: Do we plan on documenting these hint keys so folks can find/use them in beforeSend/eventProcessors?

Perhaps it'd be best to have them available in public static String's and use some sort of prefixing. To avoid conflict as more hints are added and to be easier to understand what the value represents.

Yes, the idea is to document the considered public ones, as JS does, https://docs.sentry.io/platforms/javascript/configuration/filtering/#hints-for-breadcrumbs

Some of them are already documented, e.g. originalException, syntheticException and event_id.
I'd document tho that we don't support originalException and event_id since the Event itself has these properties.

We could make a class with those constants or really just document it via docs.

[romtsn]

I think I'd also vote for having a class with constants, then all the keys are in the same place, which is easier for us and for those who is looking at the public API.

Another thing I noticed - some of the keys are capitalized and some are full-lowercase - should we align all of them and use just lowercase? (I guess the lowercase comes from JS)

[marandaneto]

Kept as it is since its part of the common docs for hints