Metrics Part 1 - Add Counter Metric API #1940

stefanosiano · 2024-03-19T12:37:38Z

📜 Description

Add Sentry Metrics to Dart SDK.
Implemented features

Counter Metric API
Metric Aggregation to locally aggregate into 10s buckets
hub integration and closing functionality
tag normalization
send of statsd envelope type
each SentryClient has its own metrics aggregator

💡 Motivation and Context

Implements first part of #1876

💚 How did you test it?

Unit tests

📝 Checklist

I reviewed submitted code
I added tests to verify changes
No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
I updated the docs if needed
All tests passing
No breaking changes

🔮 Next steps

This is an overview of the following PRs:

Add sets, gauges and distributions metrics, with overweight logic -> Add other metric types and weight (part 2) #1949
Add timing metric with span auto start and beforeEmitMetric option-> Add timing metric and beforeMetric callback (part 3) #1954
Span metrics summary -> Feat/metrics span summary p4 #1958
Add docs
Code location (currently blocked)

Also, we should add a proper changelog

added Metric Aggregation, with hub/client integration and close added metric tag normalization added send of statsd envelope type

github-actions · 2024-03-19T12:38:25Z

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

Generated by 🚫 dangerJS against 6dac9d6

github-actions · 2024-03-19T12:44:22Z

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	405.23 ms	470.62 ms	65.38 ms
Size	6.34 MiB	7.28 MiB	968.41 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`90db9ff`	334.86 ms	388.14 ms	53.28 ms
`5e8d2b3`	342.17 ms	375.83 ms	33.66 ms
`a775d3f`	359.58 ms	436.68 ms	77.10 ms
`0be962b`	325.54 ms	382.83 ms	57.29 ms
`ef6466d`	373.96 ms	443.17 ms	69.21 ms
`30c1193`	349.00 ms	438.20 ms	89.20 ms
`5aab4c5`	326.12 ms	378.82 ms	52.70 ms
`521cfbf`	332.78 ms	376.04 ms	43.26 ms
`9928a74`	375.26 ms	456.30 ms	81.04 ms
`fe4aa56`	356.06 ms	428.67 ms	72.61 ms

App size

Revision	Plain	With Sentry	Diff
`90db9ff`	6.06 MiB	7.10 MiB	1.04 MiB
`5e8d2b3`	6.15 MiB	7.13 MiB	1000.11 KiB
`a775d3f`	6.27 MiB	7.20 MiB	957.75 KiB
`0be962b`	6.06 MiB	7.03 MiB	990.29 KiB
`ef6466d`	6.34 MiB	7.28 MiB	967.79 KiB
`30c1193`	6.27 MiB	7.20 MiB	958.74 KiB
`5aab4c5`	6.06 MiB	7.10 MiB	1.04 MiB
`521cfbf`	5.94 MiB	6.97 MiB	1.03 MiB
`9928a74`	5.94 MiB	6.96 MiB	1.02 MiB
`fe4aa56`	6.06 MiB	7.10 MiB	1.04 MiB

Previous results on branch: feat/metrics_counter_p1

Startup times

Revision	Plain	With Sentry	Diff
`2fd72c4`	356.20 ms	421.38 ms	65.18 ms
`e9d9441`	403.79 ms	461.21 ms	57.42 ms
`64e1732`	375.53 ms	438.52 ms	62.99 ms
`2c4e01f`	370.35 ms	443.67 ms	73.33 ms
`61bec38`	372.04 ms	436.22 ms	64.18 ms
`aa40a3f`	352.29 ms	409.80 ms	57.51 ms

App size

Revision	Plain	With Sentry	Diff
`2fd72c4`	6.34 MiB	7.29 MiB	969.37 KiB
`e9d9441`	6.34 MiB	7.29 MiB	969.36 KiB
`64e1732`	6.34 MiB	7.29 MiB	969.18 KiB
`2c4e01f`	6.34 MiB	7.29 MiB	969.18 KiB
`61bec38`	6.34 MiB	7.29 MiB	969.36 KiB
`aa40a3f`	6.34 MiB	7.29 MiB	969.43 KiB

github-actions · 2024-03-19T12:47:11Z

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1248.16 ms	1271.74 ms	23.58 ms
Size	8.33 MiB	9.40 MiB	1.07 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`f2db4ec`	1244.14 ms	1259.79 ms	15.65 ms
`8932ece`	1234.31 ms	1238.90 ms	4.59 ms
`24f71aa`	1267.47 ms	1272.00 ms	4.53 ms
`86d4841`	1225.69 ms	1241.12 ms	15.43 ms
`31b2afb`	1244.90 ms	1261.37 ms	16.47 ms
`f79eecf`	1210.25 ms	1221.65 ms	11.40 ms
`d783424`	1265.71 ms	1277.00 ms	11.29 ms
`6957bfd`	1283.80 ms	1289.00 ms	5.20 ms
`f6f3d25`	1253.80 ms	1258.39 ms	4.59 ms
`3de8b9b`	1234.22 ms	1251.94 ms	17.72 ms

App size

Revision	Plain	With Sentry	Diff
`f2db4ec`	8.10 MiB	9.16 MiB	1.07 MiB
`8932ece`	8.29 MiB	9.36 MiB	1.07 MiB
`24f71aa`	8.10 MiB	9.16 MiB	1.07 MiB
`86d4841`	8.29 MiB	9.36 MiB	1.07 MiB
`31b2afb`	8.33 MiB	9.40 MiB	1.07 MiB
`f79eecf`	8.29 MiB	9.36 MiB	1.07 MiB
`d783424`	8.29 MiB	9.38 MiB	1.09 MiB
`6957bfd`	8.15 MiB	9.15 MiB	1020.71 KiB
`f6f3d25`	8.28 MiB	9.34 MiB	1.06 MiB
`3de8b9b`	8.28 MiB	9.34 MiB	1.06 MiB

Previous results on branch: feat/metrics_counter_p1

Startup times

Revision	Plain	With Sentry	Diff
`e9d9441`	1243.94 ms	1271.35 ms	27.41 ms
`61bec38`	1225.20 ms	1247.78 ms	22.58 ms
`2c4e01f`	1237.79 ms	1249.65 ms	11.85 ms
`aa40a3f`	1247.52 ms	1262.85 ms	15.33 ms
`64e1732`	1244.82 ms	1263.19 ms	18.37 ms
`2fd72c4`	1253.27 ms	1275.60 ms	22.34 ms

App size

Revision	Plain	With Sentry	Diff
`e9d9441`	8.33 MiB	9.40 MiB	1.07 MiB
`61bec38`	8.33 MiB	9.40 MiB	1.07 MiB
`2c4e01f`	8.33 MiB	9.40 MiB	1.07 MiB
`aa40a3f`	8.33 MiB	9.40 MiB	1.07 MiB
`64e1732`	8.33 MiB	9.40 MiB	1.07 MiB
`2fd72c4`	8.33 MiB	9.40 MiB	1.07 MiB

markushi

Awesome progress! 🚀

dart/lib/src/metrics/metric.dart

dart/lib/src/metrics/metrics_api.dart

dart/lib/src/sentry_client.dart

removed timestamp from Metric

fixed tests

dart/lib/src/sentry_envelope_item.dart

denrase

Just some small nitpicks, suggestions & questions.

dart/lib/src/metrics/metric.dart

dart/lib/src/metrics/metrics_aggregator.dart

dart/lib/src/sentry.dart

dart/lib/src/sentry_envelope_item.dart

dart/test/hub_test.dart

dart/test/sentry_envelope_item_test.dart

renamed a test

* added crc32_utils.dart, taken from archive library * added Gauge, Distribution and Set metrics * added weight to Metrics and auto flush when weight is too much * Add timing metric and beforeMetric callback (part 3) (#1954) * added SentryOptions.beforeMetricCallback * added beforeMetricCallback logic in metrics_aggregator.dart * added timing metric api with span auto start * timing api uses span duration as value for the emitted metric if possible * Feat/metrics span summary p4 (#1958) * added local_metrics_aggregator.dart to spans * metrics_aggregator.dart now adds to current span's localMetricsAggregator * added metric_summary.dart * added metricSummary to spans and transaction JSONs

…at/metrics_counter_p1

* updated metric normalization rules * added rate limit for metrics

added Counter Metric API

2fd72c4

added Metric Aggregation, with hub/client integration and close added metric tag normalization added send of statsd envelope type

kahest requested a review from denrase March 19, 2024 13:20

stefanosiano requested a review from markushi March 19, 2024 13:53

markushi reviewed Mar 21, 2024

View reviewed changes

dart/lib/src/metrics/metric.dart Outdated Show resolved Hide resolved

dart/lib/src/metrics/metrics_api.dart Show resolved Hide resolved

dart/lib/src/sentry_client.dart Show resolved Hide resolved

stefanosiano added 7 commits March 21, 2024 12:22

added tests

3e0678e

removed timestamp from Metric

formatted code

61bec38

fixed tests

fixed analyze warnings

44c9fb5

fixed tests

fixed last analyze warnings

e9d9441

fixed last test

aa40a3f

fixed last test

e589b7f

fixed last test

2c4e01f

stefanosiano commented Mar 21, 2024

View reviewed changes

dart/lib/src/sentry_envelope_item.dart Show resolved Hide resolved

stefanosiano marked this pull request as ready for review March 21, 2024 15:08

stefanosiano requested review from krystofwoldrich and buenaflor as code owners March 21, 2024 15:08

stefanosiano mentioned this pull request Mar 25, 2024

Add other metric types and weight (part 2) #1949

Merged

6 tasks

denrase approved these changes Mar 25, 2024

View reviewed changes

stefanosiano and others added 8 commits March 26, 2024 16:03

removed useless types

64e1732

renamed a test

Merge branch 'main' into feat/metrics_counter_p1

1566b79

Merge remote-tracking branch 'origin/feat/metrics_counter_p1' into fe…

19ebfbb

…at/metrics_counter_p1

updated changelog

d02f183

added metric_bucket data category for rate limits (#1973)

c611731

* updated metric normalization rules * added rate limit for metrics

Merge branch 'main' into feat/metrics_counter_p1

9072139

Merge branch 'main' into feat/metrics_counter_p1

6dac9d6

stefanosiano merged commit 84bc635 into main Apr 9, 2024
123 checks passed

stefanosiano deleted the feat/metrics_counter_p1 branch April 9, 2024 15:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metrics Part 1 - Add Counter Metric API #1940

Metrics Part 1 - Add Counter Metric API #1940

stefanosiano commented Mar 19, 2024 •

edited

github-actions bot commented Mar 19, 2024 •

edited

github-actions bot commented Mar 19, 2024 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/metrics_counter_p1

Startup times

App size

github-actions bot commented Mar 19, 2024 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/metrics_counter_p1

Startup times

App size

markushi left a comment

denrase left a comment

Metrics Part 1 - Add Counter Metric API #1940

Metrics Part 1 - Add Counter Metric API #1940

Conversation

stefanosiano commented Mar 19, 2024 • edited

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Mar 19, 2024 • edited

github-actions bot commented Mar 19, 2024 • edited

Android Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/metrics_counter_p1

Startup times

App size

github-actions bot commented Mar 19, 2024 • edited

iOS Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/metrics_counter_p1

Startup times

App size

markushi left a comment

Choose a reason for hiding this comment

denrase left a comment

Choose a reason for hiding this comment

stefanosiano commented Mar 19, 2024 •

edited

github-actions bot commented Mar 19, 2024 •

edited

github-actions bot commented Mar 19, 2024 •

edited

github-actions bot commented Mar 19, 2024 •

edited