feat(browser): Add browser metrics sdk #9794
Merged
Conversation
This file contains 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
Closed
anonrig
reviewed
Dec 11, 2023
lforst
reviewed
Dec 11, 2023
Comment on lines
1
to
4
| export const COUNTER_METRIC_TYPE = 'c'; | ||
| export const GAUGE_METRIC_TYPE = 'g'; | ||
| export const SET_METRIC_TYPE = 's'; | ||
| export const DISTRIBUTION_METRIC_TYPE = 'd'; |
There was a problem hiding this comment.
m: Since we are not using these anywhere as actual values, should we just define them as types instead?
There was a problem hiding this comment.
ended up using the constants and caught a bug f5d6333
size-limit report 📦
|
mydea
reviewed
Dec 12, 2023
mydea
reviewed
Dec 12, 2023
mydea
reviewed
Dec 12, 2023
mydea
reviewed
Dec 12, 2023
Lms24
reviewed
Dec 12, 2023
AbhiPrasad
changed the title
|
Updated the API: // Add 4 to a counter named `hits`
Sentry.metrics.increment('hits', 4);
// Add 2 to gauge named `parallel_requests`, tagged with `happy: "no"`
Sentry.metrics.gauge('parallel_requests', 2, { tags: { happy: 'no' } });
// Add 4.6 to a distribution named `response_time` with unit seconds
Sentry.metrics.distribution('response_time', 4.6, { unit: 'seconds' });
// Add 2 to a set named `valuable.ids`
Sentry.metrics.set('valuable.ids', 2); |
|
I went ahead and also refactored client and serialization logic as per @lforst feedback. It does have increased bundle size hit, but I believe it is waaaay more maintainable, thanks for keeping me honest! |
|
example envelope: In the UI: 
|
Lms24
approved these changes
Dec 13, 2023
| }; | ||
| } | ||
|
|
||
| if (!!tunnel && !!dsn) { |
There was a problem hiding this comment.
l: do we need the double !! here? we just check for definedness, no?
There was a problem hiding this comment.
we do not, will change.
cleptric
reviewed
Dec 13, 2023
| export const NAME_AND_TAG_KEY_NORMALIZATION_REGEX = /[^a-zA-Z0-9_/.-]+/g; | ||
|
|
||
| /** | ||
| * Normalization regex for metric tag balues. |
There was a problem hiding this comment.
Suggested change
| * Normalization regex for metric tag balues. | |
| * Normalization regex for metric tag values. |
mydea
approved these changes
Dec 14, 2023
anonrig
reviewed
Dec 14, 2023
| this._min = value; | ||
| this._max = value; | ||
| this._sum = value; | ||
| this._count = 1; |
There was a problem hiding this comment.
This can be moved to line 30
There was a problem hiding this comment.
For now it can't see #8700
| /** | ||
| * Simple hash function for strings. | ||
| */ | ||
| export function simpleHash(s: string): number { |
|
Based on Yagiz's PR review I refactored the tag serialization logic and also did a rename of the metrics class. Sentry.init({
dsn: '__DSN__',
integrations: [
new Sentry.metrics.MetricsAggregator(),
],
});Although the duplication of |
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.
Please read the following before reviewing:
ref #9691
This PR introduces functionality for a browser metrics SDK in an alpha state. Via the newly introduced APIs, you can now flush metrics directly to Sentry in the browser.
To enable capturing metrics, you first need to add the
Metricsintegration. This is done for treeshaking purposes.Then you'll be able to add
counters,sets,distributions, andgaugesunder theSentry.metricsnamespace.Under the hood, adding the
Metricsintegration adds aSimpleMetricsAggregator. This is a bundle-sized efficient metrics aggregator that aggregates metrics and flushes them out every 5 seconds. This does not use any weight based logic - this will be implemented in theMetricsAggregatorthat is used for server runtimes (node, deno, vercel-edge).To make metrics conditional, it is defined on the client as
public metricsAggregator: MetricsAggregator | undefined.Next step is to add some integration tests for this functionality, and then add server-runtime logic for it.
Many of the decisions taken for this aggregator + flushing implementation was to try to be as bundle size efficient as possible, happy to answer any specific questions.