feat: Add navigation.route.id and adjust pageload and navigation description rules

javascript/sentry-conventions/src/attributes.ts

@@ -10563,6 +10563,27 @@ export const NAVIGATION_ORIGIN = 'navigation.origin';
  */
 export type NAVIGATION_ORIGIN_TYPE = string;
 
+// Path: model/attributes/navigation/navigation__route__id.json
+
+/**
+ * The identifier of the matched client-side route, as assigned by the routing framework (e.g., vue-router name, react-router id). `navigation.route.id`
+ *
+ * Attribute Value Type: `string` {@link NAVIGATION_ROUTE_ID_TYPE}
+ *
+ * Apply Scrubbing: auto
+ *
+ * Attribute defined in OTEL: No
+ * Visibility: public
+ *
+ * @example "AboutView"
+ */
+export const NAVIGATION_ROUTE_ID = 'navigation.route.id';
+
+/**
+ * Type for {@link NAVIGATION_ROUTE_ID} navigation.route.id
+ */
+export type NAVIGATION_ROUTE_ID_TYPE = string;
+
 // Path: model/attributes/navigation/navigation__type.json
 
 /**
@@ -16571,6 +16592,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   method: 'string',
   'middleware.name': 'string',
   'navigation.origin': 'string',
+  'navigation.route.id': 'string',
   'navigation.type': 'string',
   'nel.elapsed_time': 'integer',
   'nel.phase': 'string',
@@ -17299,6 +17321,7 @@ export type AttributeName =
   | typeof METHOD
   | typeof MIDDLEWARE_NAME
   | typeof NAVIGATION_ORIGIN
+  | typeof NAVIGATION_ROUTE_ID
   | typeof NAVIGATION_TYPE
   | typeof NEL_ELAPSED_TIME
   | typeof NEL_PHASE
@@ -24046,6 +24069,18 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     aliases: ['sentry.sveltekit.navigation.from'],
     changelog: [{ version: 'next', prs: [467], description: 'Added navigation.origin attribute' }],
   },
+  'navigation.route.id': {
+    brief:
+      'The identifier of the matched client-side route, as assigned by the routing framework (e.g., vue-router name, react-router id).',
+    type: 'string',
+    applyScrubbing: {
+      key: 'auto',
+    },
+    isInOtel: false,
+    visibility: 'public',
+    example: 'AboutView',
+    changelog: [{ version: 'next', description: 'Added navigation.route.id attribute' }],
+  },
   'navigation.type': {
     brief: 'The type of navigation done by a client-side router.',
     type: 'string',
@@ -27672,6 +27707,7 @@ export type Attributes = {
   [METHOD]?: METHOD_TYPE;
   [MIDDLEWARE_NAME]?: MIDDLEWARE_NAME_TYPE;
   [NAVIGATION_ORIGIN]?: NAVIGATION_ORIGIN_TYPE;
+  [NAVIGATION_ROUTE_ID]?: NAVIGATION_ROUTE_ID_TYPE;
   [NAVIGATION_TYPE]?: NAVIGATION_TYPE_TYPE;
   [NEL_ELAPSED_TIME]?: NEL_ELAPSED_TIME_TYPE;
   [NEL_PHASE]?: NEL_PHASE_TYPE;

model/attributes/navigation/navigation__route__id.json

@@ -0,0 +1,17 @@
+{
+  "key": "navigation.route.id",
+  "brief": "The identifier of the matched client-side route, as assigned by the routing framework (e.g., vue-router name, react-router id).",
+  "type": "string",
+  "apply_scrubbing": {
+    "key": "auto"
+  },
+  "is_in_otel": false,
+  "example": "AboutView",
+  "visibility": "public",
+  "changelog": [
+    {
+      "version": "next",
+      "description": "Added navigation.route.id attribute"
+    }
+  ]
+}

model/description/browser.json

@@ -5,15 +5,15 @@
       "name": "Pageload",
       "brief": "A full page load of a web application.",
       "ops": ["pageload"],
-      "templates": ["{{url.template}}", "{{url.path}}", "{{url.full}}"],
-      "examples": ["/users/:id", "/users/123", "http://example.com/users/123"]
+      "templates": ["{{navigation.route.id}}", "{{url.template}}", "{{url.path}}", "{{url.full}}"],
+      "examples": ["UserProfile", "/users/:id", "/users/123", "http://example.com/users/123"]
     },
     {
       "name": "Navigation",
       "brief": "Client-side browser history change in a web application.",
       "ops": ["navigation"],
-      "templates": ["{{url.template}}", "{{url.path}}", "{{url.full}}"],
-      "examples": ["/users/:id", "/users/123", "http://example.com/users/123"]
+      "templates": ["{{navigation.route.id}}", "{{url.template}}", "{{url.path}}", "{{url.full}}"],
+      "examples": ["UserProfile", "/users/:id", "/users/123", "http://example.com/users/123"]
     }
   ]
 }

python/src/sentry_conventions/attributes.py

@@ -6249,6 +6249,17 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
     Example: "/users/:id"
     """
 
+    # Path: model/attributes/navigation/navigation__route__id.json
+    NAVIGATION_ROUTE_ID: Literal["navigation.route.id"] = "navigation.route.id"
+    """The identifier of the matched client-side route, as assigned by the routing framework (e.g., vue-router name, react-router id).
+
+    Type: str
+    Apply Scrubbing: auto
+    Defined in OTEL: No
+    Visibility: public
+    Example: "AboutView"
+    """
+
     # Path: model/attributes/navigation/navigation__type.json
     NAVIGATION_TYPE: Literal["navigation.type"] = "navigation.type"
     """The type of navigation done by a client-side router.
@@ -16339,6 +16350,19 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
             ),
         ],
     ),
+    "navigation.route.id": AttributeMetadata(
+        brief="The identifier of the matched client-side route, as assigned by the routing framework (e.g., vue-router name, react-router id).",
+        type=AttributeType.STRING,
+        apply_scrubbing=ApplyScrubbingInfo(key=ApplyScrubbing.AUTO),
+        is_in_otel=False,
+        visibility=Visibility.PUBLIC,
+        example="AboutView",
+        changelog=[
+            ChangelogEntry(
+                version="next", description="Added navigation.route.id attribute"
+            ),
+        ],
+    ),
     "navigation.type": AttributeMetadata(
         brief="The type of navigation done by a client-side router.",
         type=AttributeType.STRING,
@@ -20077,6 +20101,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
         "method": str,
         "middleware.name": str,
         "navigation.origin": str,
+        "navigation.route.id": str,
         "navigation.type": str,
         "nel.elapsed_time": int,
         "nel.phase": str,