feat(attributes): Add React Native native module call attributes

javascript/sentry-conventions/src/op.ts

@@ -437,6 +437,11 @@ export const FILE = 'file';
 
 export const SERIALIZE = 'serialize';
 
+/**
+ * A call from JavaScript into a React Native native module, or an aggregate of such calls.
+ */
+export const TURBO_MODULE = 'turbo_module';
+
 // Path: model/op/object.json
 // Name: object
 

model/attributes/react_native/react_native__architecture.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.architecture",
+  "brief": "The React Native architecture the app is running on. `new` for the New Architecture, where native modules are resolved as TurboModules through `TurboModuleRegistry`, `legacy` for the Old Architecture bridge.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["new", "legacy"],
+  "alias": ["turbo_module.arch"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.architecture attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__call__count.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.module.call.count",
+  "brief": "The number of native module calls observed during the lifetime of the span.",
+  "type": "integer",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [42],
+  "alias": ["turbo_module.total_call_count", "turbo_modules.total_call_count"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.call.count attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__call__distinct_count.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.module.call.distinct_count",
+  "brief": "The number of distinct native module and method pairs called during the lifetime of the span. Useful as a cardinality signal when the per-method breakdown has been truncated.",
+  "type": "integer",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [7],
+  "alias": ["turbo_module.unique_methods", "turbo_modules.unique_methods"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.call.distinct_count attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__duration__max.json

@@ -0,0 +1,18 @@
+{
+  "key": "react_native.module.duration.max",
+  "brief": "The duration of the slowest single native module call observed during the lifetime of the span, in milliseconds.",
+  "type": "double",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [512.5],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.duration.max attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__duration__total.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.module.duration.total",
+  "brief": "The combined wall-clock duration of all native module calls observed during the lifetime of the span, in milliseconds. Calls overlap, so this can exceed the span duration.",
+  "type": "double",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [128.45],
+  "alias": ["turbo_module.total_duration_ms", "turbo_modules.total_duration_ms"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.duration.total attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__error__count.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.module.error.count",
+  "brief": "The number of native module calls that failed during the lifetime of the span. A call counts as failed when it threw, rejected, or \u2014 on the Old Architecture bridge only \u2014 invoked its failure callback.",
+  "type": "integer",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [2],
+  "alias": ["turbo_module.total_error_count", "turbo_modules.total_error_count"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.error.count attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__kind.json

@@ -0,0 +1,18 @@
+{
+  "key": "react_native.module.kind",
+  "brief": "Whether the native module call completed synchronously or reported completion later through a Promise or a callback. One of `sync` or `async`.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["sync", "async"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.kind attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__method.json

@@ -0,0 +1,20 @@
+{
+  "key": "react_native.module.method",
+  "brief": "The name of the native module method that was called.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["getUniqueId"],
+  "alias": ["turbo_module.method"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.method attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__name.json

@@ -0,0 +1,20 @@
+{
+  "key": "react_native.module.name",
+  "brief": "The name of the native module the call was dispatched to. On the New Architecture this is the TurboModule name, on the Old Architecture the `NativeModules` key.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["RNDeviceInfo"],
+  "alias": ["turbo_module.name"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.name attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__top__duration.json

@@ -0,0 +1,19 @@
+{
+  "key": "react_native.module.top.duration",
+  "brief": "The total duration attributed to `react_native.module.top.name`, in milliseconds.",
+  "type": "double",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [87.25],
+  "alias": ["turbo_module.top_module_duration_ms"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.top.duration attribute"
+    }
+  ]
+}

model/attributes/react_native/react_native__module__top__name.json

@@ -0,0 +1,20 @@
+{
+  "key": "react_native.module.top.name",
+  "brief": "The native module and method that accounted for the most total duration during the lifetime of the span, formatted as `<module>.<method>`.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["RNDeviceInfo.getUniqueId"],
+  "alias": ["turbo_module.top_module"],
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added react_native.module.top.name attribute"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__arch.json

@@ -0,0 +1,24 @@
+{
+  "key": "turbo_module.arch",
+  "brief": "The React Native architecture the call was observed on. `new` for a TurboModule resolved through `TurboModuleRegistry`, `legacy` for a module reached over the Old Architecture bridge. Only applies to React Native.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["new", "legacy"],
+  "alias": ["react_native.architecture"],
+  "deprecation": {
+    "replacement": "react_native.architecture",
+    "reason": "Replaced by the `react_native.*` namespace, which also covers native module calls made over the Old Architecture bridge, which are not TurboModules",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.arch and deprecated it in favor of react_native.architecture"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__method.json

@@ -0,0 +1,25 @@
+{
+  "key": "turbo_module.method",
+  "brief": "The name of the native module method that was called. Only applies to React Native.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["getUniqueId"],
+  "alias": ["react_native.module.method"],
+  "deprecation": {
+    "replacement": "react_native.module.method",
+    "reason": "Replaced by the `react_native.*` namespace, which also covers native module calls made over the Old Architecture bridge, which are not TurboModules",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.method and deprecated it in favor of react_native.module.method"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__name.json

@@ -0,0 +1,25 @@
+{
+  "key": "turbo_module.name",
+  "brief": "The name of the native module the call was dispatched to. On the New Architecture this is the TurboModule name, on the Old Architecture the `NativeModules` key. Only applies to React Native.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["RNDeviceInfo"],
+  "alias": ["react_native.module.name"],
+  "deprecation": {
+    "replacement": "react_native.module.name",
+    "reason": "Replaced by the `react_native.*` namespace, which also covers native module calls made over the Old Architecture bridge, which are not TurboModules",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.name and deprecated it in favor of react_native.module.name"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__top_module.json

@@ -0,0 +1,25 @@
+{
+  "key": "turbo_module.top_module",
+  "brief": "The native module and method that accounted for the most total duration during the lifetime of the span. Only applies to React Native.",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "manual",
+    "reason": "Native module and method names are app-defined identifiers, but scrubbing them would make the call attribution unusable"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": ["RNDeviceInfo.getUniqueId"],
+  "alias": ["react_native.module.top.name"],
+  "deprecation": {
+    "replacement": "react_native.module.top.name",
+    "reason": "Replaced by the `react_native.module.*` namespace, which also covers native module calls made over the Old Architecture bridge, and which drops the `total_` prefix and `_ms` suffix in favor of dot-separated logical grouping",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.top_module and deprecated it in favor of react_native.module.top.name"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__top_module_duration_ms.json

@@ -0,0 +1,24 @@
+{
+  "key": "turbo_module.top_module_duration_ms",
+  "brief": "The total duration attributed to the top native module method, in milliseconds. Only applies to React Native.",
+  "type": "double",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [87.25],
+  "alias": ["react_native.module.top.duration"],
+  "deprecation": {
+    "replacement": "react_native.module.top.duration",
+    "reason": "Replaced by the `react_native.module.*` namespace, which also covers native module calls made over the Old Architecture bridge, and which drops the `total_` prefix and `_ms` suffix in favor of dot-separated logical grouping",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.top_module_duration_ms and deprecated it in favor of react_native.module.top.duration"
+    }
+  ]
+}

model/attributes/turbo_module/turbo_module__total_call_count.json

@@ -0,0 +1,24 @@
+{
+  "key": "turbo_module.total_call_count",
+  "brief": "The number of native module calls observed during the lifetime of the span. Only applies to React Native.",
+  "type": "integer",
+  "apply_scrubbing": {
+    "key": "manual"
+  },
+  "is_in_otel": false,
+  "visibility": "public",
+  "examples": [42],
+  "alias": ["react_native.module.call.count", "turbo_modules.total_call_count"],
+  "deprecation": {
+    "replacement": "react_native.module.call.count",
+    "reason": "Replaced by the `react_native.module.*` namespace, which also covers native module calls made over the Old Architecture bridge, and which drops the `total_` prefix and `_ms` suffix in favor of dot-separated logical grouping",
+    "_status": "backfill"
+  },
+  "changelog": [
+    {
+      "version": "next",
+      "prs": [564],
+      "description": "Added turbo_module.total_call_count and deprecated it in favor of react_native.module.call.count"
+    }
+  ]
+}