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

adinauer · 2025-12-22T12:48:35Z

📜 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 · 2025-12-22T12:48:52Z

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

github-actions · 2025-12-22T12:49:11Z

	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 e156d3c

adinauer · 2025-12-22T13:00:55Z

sentry/src/main/java/io/sentry/SentryOptions.java

+  public static final class Metrics {
+
+    /** Whether Sentry Metrics feature is enabled and metrics are sent to Sentry. */
+    private boolean enable = false;


changed to true in a follow up PR

adinauer · 2025-12-22T13:01:12Z

sentry/src/main/java/io/sentry/SentryOptions.java

+       */
+      // TODO replace with SentryMetric
+      @Nullable
+      Object execute(@NotNull Object metric);


Signature updated in follow-up PRs

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)

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.

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.

A couple things I found:

Adding Hint to EventProcessor and metrics.beforeSend can easily be done

Passing Hint to ITransport is more tricky since I wouldn't know how to combine / chose Hint when there's a batch of metrics that each have their own Hint. So I'd suggest we skip passing Hint to ITransport for now.

I'm not quite sure where to add Hint to IMetricsApi method signatures.

Could add it as a param, making the overload pyramid worse

Could also add it to SentryMetricsParams

Any thoughts @romtsn and @markushi ?

adinauer · 2025-12-22T13:01:42Z

sentry/src/main/java/io/sentry/SentryOptions.java

    this.logs = logs;
  }

+  @ApiStatus.Experimental


New APIs should not be marked Experimental

github-actions · 2025-12-22T14:00:49Z

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.

sentry/src/main/java/io/sentry/SentryOptions.java

markushi · 2026-01-08T06:47:09Z

sentry/src/main/java/io/sentry/SentryOptions.java

+       */
+      // TODO replace with SentryMetric
+      @Nullable
+      Object execute(@NotNull Object metric);


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 · 2026-01-14T08:03:29Z

@sentry review

adinauer · 2026-01-14T08:03:34Z

cursor review

cursor

✅ Bugbot reviewed your changes and found no bugs!

* Metrics Options * MetricsApi stub * Add transport types for metrics * Enable metrics by default * Format code * Add batch processor for Metrics * Wire up Metrics parts * Metrics counter basic API * Metrics Count API * Metrics Distribution API * Metrics Gauge API * Metrics Envelope item deserialization * Record client report for discarded metrics envelope item * Metrics external options * Metrics Manifest options for Android * Android Metrics batch processor and factory * Only send user attributes if sendDefaultPii is true * Remove Experimental Annotation from Metrics Options * Add unit tests for Metrics * Create SentryMetricsParameters for Metrics * Use uv for managing python version * fix * Add device and OS attributes to metrics * Add AI rules files for Metrics (and update feature flags rule) * Close and flush MetricsBatchProcessor from SentryClient * fix * Add E2E tests for Metrics * Final keyword in Metrics methods * Add Hint to Metrics * SentryMetricsParameters create shortcut for attributes map * Automatically use SentryOptions.Metrics.BeforeSendMetricCallback Spring beans * Rename sample API param, remove sleep * Create MetricsUnit constants * Format code * Metrics Options (#4980) * feat(metrics): [Trace Metrics 2] MetricsApi stub (#4981) * Metrics Options * MetricsApi stub * More PR review changes (#5028) * Some more PR review changes * Format code --------- Co-authored-by: Sentry Github Bot <[email protected]> * changelog * non nullable trace id * error log now says metric instead of log --------- Co-authored-by: Sentry Github Bot <[email protected]> Co-authored-by: lcian <[email protected]>

adinauer changed the title ~~Metrics Options~~ feat(metrics): [1] Metrics Options Dec 22, 2025

adinauer changed the title ~~feat(metrics): [1] Metrics Options~~ feat(metrics): [Trace Metrics 1] Metrics Options Dec 22, 2025

adinauer commented Dec 22, 2025

View reviewed changes

adinauer force-pushed the 12-17-metrics_options branch from 3513eaa to 857a7aa Compare December 22, 2025 13:41

romtsn approved these changes Dec 22, 2025

View reviewed changes

markushi approved these changes Jan 8, 2026

View reviewed changes

Metrics Options

e156d3c

adinauer force-pushed the 12-17-metrics_options branch from 857a7aa to e156d3c Compare January 9, 2026 10:26

adinauer marked this pull request as ready for review January 14, 2026 05:57

adinauer requested a review from lcian as a code owner January 14, 2026 05:57

cursor bot reviewed Jan 14, 2026

View reviewed changes

adinauer changed the base branch from main to feat/trace-metrics January 14, 2026 09:08

adinauer merged commit e7b20a0 into feat/trace-metrics Jan 14, 2026
35 of 38 checks passed

adinauer deleted the 12-17-metrics_options branch January 14, 2026 09:09

Uh oh!

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

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

Conversation

adinauer commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

adinauer commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions and example for changelog

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 22, 2025

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Uh oh!

markushi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adinauer commented Jan 14, 2026

Uh oh!

adinauer commented Jan 14, 2026

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adinauer commented Dec 22, 2025 •

edited

Loading

adinauer commented Dec 22, 2025 •

edited

Loading

github-actions bot commented Dec 22, 2025 •

edited

Loading