feat(instrumentation-react-native-navigation): Adding new instrumentation library to track navigation changes for React Native apps

[facostaembrace]

Which problem is this PR solving?

A couple of months ago, my team (Embrace) and I were looking for an instrumentation library that creates telemetry data for React Native applications. However, we noticed there was nothing available that adhered to open source standards. We also noticed people in Stack Overflow was asking about something similar.
This instrumentation library exposes two components that can be implemented at the root of React Native applications to create telemetry data that tracks navigation changes for the most popular navigation approaches in this environment.
Instrumentation request here.

#1089

Short description of the changes

• Introduce a new instrumentation library to kick off a React Native ecosystem.
• Exposes two components: <NativeNavigationTracker /> that creates spans and track navigation changes for wix/react-native-navigation library, and <NavigationTracker /> that is meant to be used when the application handles the navigation using @react-navigation/native or expo-router.
• Both components have the ability of adding a minimum set of configurations.
• Both components receives a custom provider, but if it is not passed it can also create telemetry data using the global one.
• Configuration for both allows to add static attributes for spans.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: facostaembrace / name: Florencia Acosta (f3ae613, eea8205, a7265bf, d75cb7f, fa5aae4, 197db51, 4f0c944, 4c06c41, 907a0d5, 54b1463, a671951, 8ce7abb, f6a696e, 883296f, d8830b3, 8716b2a, ab87452, 0a6b4a0, 7042067, 0beb3a3, 560152a, 989db3e, 36d0e1d, 9227be9, 0586cc0, fc36c13, 4104534, 6847592, c47c8c1, 201d182, 1d3d287, 02a52fa, f081191, d22d280, be802f6, 559eae1, 51ad05f, e50ee23, 7938a24, fc7e131, da4d57f)

[facostaembrace]

Fyi: still pending to submit the Instrumentation request that introduces this initiative.
Update: done (request here)

[jpmunz]

seems like this file was accidentally updated

[facostaembrace]

true. reverting. thanks for catching this

[codecov]

Codecov Report

Attention: Patch coverage is 93.49112% with 11 lines in your changes missing coverage. Please review.

Project coverage is 90.85%. Comparing base (6b4e532) to head (02a52fa).

Files with missing lines	Patch %	Lines
...ct-native-navigation/src/utils/hooks/useConsole.ts	55.55%	8 Missing ⚠️
...n-react-native-navigation/src/utils/spanFactory.ts	94.44%	2 Missing ⚠️
...native-navigation/src/hooks/useAppStateListener.ts	94.11%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2359      +/-   ##
==========================================
+ Coverage   90.79%   90.85%   +0.05%     
==========================================
  Files         169      176       +7     
  Lines        8061     8230     +169     
  Branches     1646     1681      +35     
==========================================
+ Hits         7319     7477     +158     
- Misses        742      753      +11     

Files with missing lines	Coverage Δ
...navigation/src/hooks/useNativeNavigationTracker.ts	100.00% <100.00%> (ø)
...ative-navigation/src/hooks/useNavigationTracker.ts	100.00% <100.00%> (ø)
...ct-native-navigation/src/utils/hooks/useSpanRef.ts	100.00% <100.00%> (ø)
...-native-navigation/src/utils/hooks/useTracerRef.ts	100.00% <100.00%> (ø)
...native-navigation/src/hooks/useAppStateListener.ts	94.11% <94.11%> (ø)
...n-react-native-navigation/src/utils/spanFactory.ts	94.44% <94.44%> (ø)
...ct-native-navigation/src/utils/hooks/useConsole.ts	55.55% <55.55%> (ø)

[kndri]

So @facostaembrace - do you need another maintainer here to get this reviewed? If so I volunteer to help maintain this with you.

[facostaembrace]

So @facostaembrace - do you need another maintainer here to get this reviewed? If so I volunteer to help maintain this with you.

Hi @kndri ! I think I already have maintainers for this new package but all help is well received!
What I need now is an admin approving the workflows for running once again and then hitting the merge button.
But for sure you can take a look and provide feedback if you want!

Thanks for the interest!!

[JamieDanielson]

We'd like to help keep this moving forward, and want to give you more leeway especially as this is 0.1.0 and it will be valuable to get feedback on how this works. This is the top requested feature in js-contrib.

@facostaembrace @jpmunz we'd like to add you to a triagers team and set a specific path in the CODEOWNERS path for you. We are working on this for other packages as well to ensure folks are pinged and assigned appropriately, as well as given the power to approve PRs (with the green check). To do this we need you to join the OpenTelemetry org.

I am working on some updated guidelines to add to the repo, but in the meantime please follow these guidelines in the community repo for member requirements.

[facostaembrace]

@JamieDanielson I see in the Issue's template that I should mention two sponsors that "meet the sponsor requirements listed in the community membership guidelines". Am right assuming I can tag you + one person from the regular JS SIG meeting? (we can also discuss about this during tomorrow's meeting). Thanks!