APM for hive

[denrase]

📜 Description

Sentry hive support.

• Introduces sentry wrappers for Hive, BoxBase, Box, LazyBox & BoxCollection
• Automatically create spans for all async methods
• Adds examples, readme, workflows & tests

💡 Motivation and Context

Relates to #1226

💚 How did you test it?

• Unit tests
• Ran sentry flutter example app

📝 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

• Breadcrumbs for hive
• Integrate with sentry file tracing

[github-actions]

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

Generated by 🚫 dangerJS against 19ebd4b

[codecov]

Codecov Report

Attention: 78 lines in your changes are missing coverage. Please review.

Comparison is base (051e97a) 90.26% compared to head (19ebd4b) 89.39%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
hive/lib/src/sentry_box_base.dart	55.05%	40 Missing ⚠️
hive/lib/src/sentry_hive_impl.dart	72.72%	12 Missing ⚠️
hive/lib/src/sentry_box.dart	9.09%	10 Missing ⚠️
hive/lib/src/default_key_comparator.dart	0.00%	9 Missing ⚠️
hive/lib/src/sentry_box_collection.dart	87.50%	4 Missing ⚠️
hive/lib/src/default_compaction_strategy.dart	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1672      +/-   ##
==========================================
- Coverage   90.26%   89.39%   -0.87%     
==========================================
  Files         189      197       +8     
  Lines        6336     6516     +180     
==========================================
+ Hits         5719     5825     +106     
- Misses        617      691      +74     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Android Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	362.00 ms	435.20 ms	73.20 ms
Size	6.27 MiB	7.20 MiB	959.08 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
521cfbf	332.78 ms	376.04 ms	43.26 ms
9f05645	349.43 ms	437.24 ms	87.81 ms
95d0636	301.46 ms	357.98 ms	56.52 ms
1edf30e	334.00 ms	378.35 ms	44.35 ms
457a85b	312.37 ms	376.67 ms	64.31 ms
559d28f	302.35 ms	339.53 ms	37.18 ms
5aa047a	329.45 ms	403.18 ms	73.73 ms
d783424	302.08 ms	368.10 ms	66.02 ms
1e781fc	315.51 ms	383.76 ms	68.24 ms
fbf42af	323.04 ms	365.09 ms	42.04 ms

App size

Revision	Plain	With Sentry	Diff
521cfbf	5.94 MiB	6.97 MiB	1.03 MiB
9f05645	6.27 MiB	7.20 MiB	958.60 KiB
95d0636	6.16 MiB	7.14 MiB	1007.32 KiB
1edf30e	5.94 MiB	6.96 MiB	1.02 MiB
457a85b	6.06 MiB	7.09 MiB	1.03 MiB
559d28f	5.94 MiB	6.92 MiB	1001.70 KiB
5aa047a	6.16 MiB	7.14 MiB	1011.25 KiB
d783424	6.16 MiB	7.14 MiB	1007.48 KiB
1e781fc	6.06 MiB	7.03 MiB	995.72 KiB
fbf42af	5.94 MiB	6.96 MiB	1.02 MiB

Previous results on branch: feat/hive

Startup times

Revision	Plain	With Sentry	Diff
296e25e	359.72 ms	445.34 ms	85.62 ms
2fa0411	355.62 ms	427.88 ms	72.26 ms
380c8a2	375.20 ms	397.57 ms	22.37 ms
22a1637	345.54 ms	417.20 ms	71.66 ms
158f93f	367.08 ms	438.57 ms	71.49 ms
e5c2b9b	361.86 ms	437.36 ms	75.50 ms
22bed30	356.33 ms	456.59 ms	100.27 ms
69d6404	361.64 ms	433.02 ms	71.38 ms
e35a82d	340.80 ms	423.10 ms	82.30 ms
9e02a29	390.64 ms	477.71 ms	87.07 ms

App size

Revision	Plain	With Sentry	Diff
296e25e	6.27 MiB	7.20 MiB	956.36 KiB
2fa0411	6.27 MiB	7.20 MiB	956.05 KiB
380c8a2	6.27 MiB	7.20 MiB	958.73 KiB
22a1637	6.27 MiB	7.20 MiB	957.75 KiB
158f93f	6.27 MiB	7.20 MiB	958.83 KiB
e5c2b9b	6.27 MiB	7.20 MiB	956.36 KiB
22bed30	6.27 MiB	7.20 MiB	956.36 KiB
69d6404	6.27 MiB	7.20 MiB	956.51 KiB
e35a82d	6.27 MiB	7.20 MiB	956.36 KiB
9e02a29	6.27 MiB	7.20 MiB	958.74 KiB

[github-actions]

iOS Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1254.69 ms	1264.92 ms	10.22 ms
Size	8.28 MiB	9.34 MiB	1.06 MiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
7e30648	1241.43 ms	1255.76 ms	14.33 ms
f0fcbe1	1238.08 ms	1243.44 ms	5.36 ms
9d43f71	1225.06 ms	1227.06 ms	2.00 ms
a7acb24	1296.71 ms	1317.69 ms	20.98 ms
d783424	1265.71 ms	1277.00 ms	11.29 ms
3e33891	6245.86 ms	6260.90 ms	15.04 ms
211a7aa	1258.02 ms	1275.65 ms	17.63 ms
a2ec542	1258.33 ms	1267.20 ms	8.88 ms
22ed6cb	1277.41 ms	1283.76 ms	6.35 ms
c1bb00f	1265.14 ms	1290.85 ms	25.71 ms

App size

Revision	Plain	With Sentry	Diff
7e30648	8.29 MiB	9.36 MiB	1.07 MiB
f0fcbe1	8.29 MiB	9.38 MiB	1.09 MiB
9d43f71	8.29 MiB	9.39 MiB	1.10 MiB
a7acb24	8.16 MiB	9.17 MiB	1.01 MiB
d783424	8.29 MiB	9.38 MiB	1.09 MiB
3e33891	8.29 MiB	9.38 MiB	1.09 MiB
211a7aa	8.10 MiB	9.18 MiB	1.08 MiB
a2ec542	8.10 MiB	9.14 MiB	1.05 MiB
22ed6cb	8.10 MiB	9.17 MiB	1.08 MiB
c1bb00f	8.09 MiB	9.07 MiB	1001.06 KiB

Previous results on branch: feat/hive

Startup times

Revision	Plain	With Sentry	Diff
e5c2b9b	1235.96 ms	1244.77 ms	8.81 ms
2fa0411	1247.04 ms	1261.00 ms	13.96 ms
5f7c196	1236.10 ms	1253.96 ms	17.86 ms
e35a82d	1226.59 ms	1254.81 ms	28.22 ms
22bed30	1235.22 ms	1242.66 ms	7.43 ms
380c8a2	1246.88 ms	1268.84 ms	21.96 ms
22a1637	1235.41 ms	1247.57 ms	12.16 ms
69d6404	1258.96 ms	1273.88 ms	14.92 ms
296e25e	1261.00 ms	1273.61 ms	12.61 ms
bee44de	1238.94 ms	1260.88 ms	21.94 ms

App size

Revision	Plain	With Sentry	Diff
e5c2b9b	8.28 MiB	9.34 MiB	1.05 MiB
2fa0411	8.28 MiB	9.33 MiB	1.05 MiB
5f7c196	8.28 MiB	9.34 MiB	1.06 MiB
e35a82d	8.28 MiB	9.34 MiB	1.05 MiB
22bed30	8.28 MiB	9.34 MiB	1.05 MiB
380c8a2	8.28 MiB	9.34 MiB	1.06 MiB
22a1637	8.28 MiB	9.34 MiB	1.06 MiB
69d6404	8.28 MiB	9.34 MiB	1.05 MiB
296e25e	8.28 MiB	9.34 MiB	1.05 MiB
bee44de	8.28 MiB	9.34 MiB	1.05 MiB

[ueman]

Have you tried combining this with the file integration? Hive is file backed, so that should make traces even more useful because you could see which operations result in file io.

I guess file io with *.box file name endings can be considered as Hive files.

[denrase]

@ueman Cool idea, will play around with this and would do this in a separate PR.

[buenaflor]

Left one comment but other than that looks good

[buenaflor]

nice 👍

before merging add hive as a pub.dev target in craft.yml.

We will add it to the registry later after we did a successful release. The sentry registry needs a previous release to associate to, that's why we can't add it now.

Also the package-analysis failing is normal so we can go ahead and merge when everything else is green. (however there are analyze warnings/errors that needs fixing)