feat(metrics): Add public API to collect count, distribution and gauge #6957
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
philprime
requested review from
itaybre,
noahsmartin and
philipphofmann
as code owners
7 tasks
Contributor
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## philprime/metrics-envelope #6957 +/- ##
=================================================================
+ Coverage 7.044% 84.973% +77.928%
=================================================================
Files 430 468 +38
Lines 26644 28110 +1466
Branches 10356 12500 +2144
=================================================================
+ Hits 1877 23886 +22009
+ Misses 24754 4184 -20570
- Partials 13 40 +27
... and 442 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
philprime
changed the base branch from
philprime/metrics-bootstrap
to
philprime/metrics
philprime
force-pushed
the
philprime/metrics-public-api
branch
from
7158dfc to
87379ed
Compare
7 tasks
philprime
force-pushed
the
philprime/metrics-public-api
branch
from
4c30f13 to
02c3573
Compare
philprime
changed the base branch from
philprime/metrics
to
philprime/metrics-envelope
philprime
force-pushed
the
philprime/metrics-public-api
branch
from
02c3573 to
1ab754c
Compare
7 tasks
Member
Author
|
@sentry review |
philprime
added
the
dontmerge
…add corresponding unit test
Contributor
🚨 Detected changes in high risk code 🚨High-risk code can easily blow up and is hard to test. We had severe bugs in the past. Be extra careful when changing these files, and have an extra careful look at these:
|
…lprime/metrics-public-api
…ison - Updated the test for protocol-based conversion of Float arrays to Double arrays to use accuracy for floating-point comparisons. - Added explanatory comments regarding the nature of Float literals and the importance of tolerance in comparisons.
- Changed the metrics enablement check to reference the experimental options in SentrySDKInternal. - Adjusted the return statement for metrics integration to improve clarity and consistency.
The test was failing because it created a span without setting its traceId. Since the fix now uses span.traceId when a span is active, the test needs to set the span's traceId to match the propagationContext traceId for consistency.
- Eliminated the isMetricsEnabled property from the SentryMetricsApiDependencies protocol, simplifying the dependency structure. - Updated related code to ensure metrics integration is nullable, enhancing clarity on metrics availability. - Adjusted tests to reflect the removal of isMetricsEnabled, ensuring they accurately simulate scenarios where metrics are disabled.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is part of a merge-chain and should be merged one-by-one into
mainas soon as all of them are ready to be merged:This PR must also wait for #7077 to be merged
📜 Description
This pull request introduces a new metrics API to the codebase, allowing clients to record custom metrics such as counts, distributions, and gauges. The API is exposed via the
SentrySDK.metricsproperty and is designed for future extensibility, though the current implementation is a no-op.This PR also adds an example UI to manually collect metrics in iOS-Swift.
💡 Motivation and Context
Closes #6949
💚 How did you test it?
📝 Checklist
You have to check all boxes before merging:
sendDefaultPIIis enabled.TODO
AttributableandAttributeValueto support type-safe bool, string, int, float, double literal values and variablesAddAttributeArrayValueto support type-safe arrays without mixed types