feat(metrics): [Trace Metrics 1] Metrics Options

[adinauer]

📜 Description

Add options for Metrics to SentryOptions:

• SentryOptions.getMetrics().setEnabled(true)
• SentryOptions.getMetrics().setBeforeSend(...)

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

• I added GH Issue ID & Linear ID
• I added tests to verify the changes.
• No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
• I updated the docs if needed.
• I updated the wizard if needed.
• Review from the native team if needed.
• No breaking change or entry added to the changelog.
• No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

[adinauer]

• feat(metrics): [Trace Metrics 23] Add E2E tests for Metrics #5011
• feat(metrics): [Trace Metrics 22] Close and flush MetricsBatchProcessor from SentryClient #5010
• Use uv for managing python version #5009
• feat(metrics): [Trace Metrics 21] Add AI rules files for Metrics (and update feature flags rule) #5008
• feat(metrics): [Trace Metrics 20] Add device and OS attributes to metrics #5007
• feat(metrics): [Trace Metrics 19] Create SentryMetricsParameters for Metrics #5006
• feat(metrics): [Trace Metrics 18] Add unit tests for Metrics #5005
• feat(metrics): [Trace Metrics 17] Remove Experimental Annotation from Metrics Options #4996
• feat(metrics): [Trace Metrics 16] Only send user attributes if sendDefaultPii is true #4995
• feat(metrics): [Trace Metrics 15] Android Metrics batch processor and factory #4994
• feat(metrics): [Trace Metrics 14] Metrics Manifest options for Android #4993
• feat(metrics): [Trace Metrics 13] Metrics external options #4992
• feat(metrics): [Trace Metrics 12] Record client report for discarded metrics envelope item #4991
• feat(metrics): [Trace Metrics 11] Metrics Envelope item deserialization #4990
• feat(metrics): [Trace Metrics 10] Metrics Gauge API #4989
• feat(metrics): [Trace Metrics 9] Metrics Distribution API #4988
• feat(metrics): [Trace Metrics 8] Metrics Count API #4987
• feat(metrics): [Trace Metrics 7] Metrics counter basic API #4986
• feat(metrics): [Trace Metrics 6] Implement SentryClient for Metrics #4985
• feat(metrics): [Trace Metrics 5] Add batch processor for Metrics #4984
• feat(metrics): [Trace Metrics 4] Add transport types for metrics #4983
• feat(metrics): [Trace Metrics 3] Enable metrics by default #4982
• feat(metrics): [Trace Metrics 2] MetricsApi stub #4981
• feat(metrics): [Trace Metrics 1] Metrics Options #4980 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

	Fails
🚫	Please consider adding a changelog entry for the next release.

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

### Features

- [Trace Metrics 1] Metrics Options ([#4980](https://github.com/getsentry/sentry-java/pull/4980))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description or adding a skip-changelog label.

Generated by 🚫 dangerJS against 857a7aa

[adinauer]

changed to true in a follow up PR

[adinauer]

Signature updated in follow-up PRs

[romtsn]

do we need any kind of hint here? just wondering if it makes sense to add it now to not break this API in the future in case we need it (i'm imagining if we start sending default metrics like Android's AppExitReasons, the hint could be a good place to expose some information along)

[markushi]

IMHO metrics are much more similar to logs where we also do not have a hint. Given that the volume of metrics could be way higher than for events I'm fine with not having hints. We can revisit before unmarking the options as experimental too.

[adinauer]

We're planning to release as non experimental right away. IIRC hints were a bit odd on logs due to batching. I can do a quick experiment whether adding Hint is simple.

[adinauer]

New APIs should not be marked Experimental

[github-actions]

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	311.43 ms	367.38 ms	55.95 ms
Size	1.58 MiB	2.13 MiB	559.66 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
33a08cc	267.08 ms	340.45 ms	73.37 ms
fc5ccaf	256.80 ms	322.36 ms	65.56 ms
fc5ccaf	276.52 ms	370.46 ms	93.93 ms
ee747ae	386.94 ms	431.43 ms	44.49 ms
fcec2f2	311.35 ms	384.94 ms	73.59 ms
cf708bd	408.35 ms	458.98 ms	50.63 ms
b3d8889	420.46 ms	453.71 ms	33.26 ms
ed33deb	337.52 ms	484.06 ms	146.54 ms
dba088c	365.46 ms	366.31 ms	0.85 ms
9fbb112	361.43 ms	427.57 ms	66.14 ms

App size

Revision	Plain	With Sentry	Diff
33a08cc	1.58 MiB	2.12 MiB	555.28 KiB
fc5ccaf	1.58 MiB	2.13 MiB	557.54 KiB
fc5ccaf	1.58 MiB	2.13 MiB	557.54 KiB
ee747ae	1.58 MiB	2.10 MiB	530.95 KiB
fcec2f2	1.58 MiB	2.12 MiB	551.51 KiB
cf708bd	1.58 MiB	2.11 MiB	539.71 KiB
b3d8889	1.58 MiB	2.10 MiB	535.07 KiB
ed33deb	1.58 MiB	2.13 MiB	559.52 KiB
dba088c	1.58 MiB	2.13 MiB	558.99 KiB
9fbb112	1.58 MiB	2.11 MiB	539.18 KiB

[markushi]

LGTM, just a tiny nit about using final for a few method arguments.

[markushi]

IMHO metrics are much more similar to logs where we also do not have a hint. Given that the volume of metrics could be way higher than for events I'm fine with not having hints. We can revisit before unmarking the options as experimental too.