ref: Ensure all aliases have a corresponding file

generated/attributes/client.md

@@ -18,7 +18,7 @@ Client address - domain name if available without reverse DNS lookup; otherwise,
 | Has PII | false |
 | Exists in OpenTelemetry | Yes |
 | Example | `example.com` |
-| Aliases | `http.client_id` |
+| Aliases | `http.client_ip` |
 
 ### client.port
 

generated/attributes/db.md

@@ -32,7 +32,6 @@ The name of a collection (table, container) within the database.
 | Has PII | false |
 | Exists in OpenTelemetry | Yes |
 | Example | `users` |
-| Aliases | `db.collection` |
 
 ### db.namespace
 

generated/attributes/http.md

@@ -229,7 +229,7 @@ The encoded body size of the response (in bytes).
 | Has PII | false |
 | Exists in OpenTelemetry | Yes |
 | Example | `123` |
-| Aliases | `http.response_content_length`, `http.response.header.content-length`, `http.response.header['content-length']` |
+| Aliases | `http.response_content_length`, `http.response.header.content-length` |
 
 ### http.response.header.\<key\>
 
@@ -305,7 +305,7 @@ Client address - domain name if available without reverse DNS lookup; otherwise,
 | Has PII | false |
 | Exists in OpenTelemetry | Yes |
 | Example | `example.com` |
-| Deprecated | Yes, use `http.client_ip` instead |
+| Deprecated | Yes, use `client.address` instead |
 | Aliases | `client.address` |
 
 ### http.flavor
@@ -359,7 +359,7 @@ The encoded body size of the response (in bytes).
 | Exists in OpenTelemetry | Yes |
 | Example | `123` |
 | Deprecated | Yes, use `http.response.body.size` instead |
-| Aliases | `http.response.body.size`, `http.response.header.content-length`, `http.response.header['content-length']` |
+| Aliases | `http.response.body.size`, `http.response.header.content-length` |
 
 ### http.response_transfer_size
 

generated/attributes/sentry.md

@@ -130,7 +130,6 @@ A parameterized route for a function in Next.js that contributes to Server-Side
 | Has PII | false |
 | Exists in OpenTelemetry | No |
 | Example | `/posts/[id]/layout` |
-| Aliases | `sentry.nextjs.function.route` |
 
 ### sentry.nextjs.ssr.function.type
 
@@ -142,7 +141,6 @@ A descriptor for a for a function in Next.js that contributes to Server-Side Ren
 | Has PII | false |
 | Exists in OpenTelemetry | No |
 | Example | `generateMetadata` |
-| Aliases | `sentry.nextjs.function.type` |
 
 ### sentry.op
 

javascript/sentry-conventions/src/attributes.ts

@@ -979,7 +979,7 @@ export type CHANNEL_TYPE = string;
  *
  * Attribute defined in OTEL: Yes
  *
- * Aliases: {@link HTTP_CLIENT_ID} `http.client_id`
+ * Aliases: {@link HTTP_CLIENT_IP} `http.client_ip`
  *
  * @example "example.com"
  */
@@ -1237,8 +1237,6 @@ export type CODE_NAMESPACE_TYPE = string;
  *
  * Attribute defined in OTEL: Yes
  *
- * Aliases: {@link DB_COLLECTION} `db.collection`
- *
  * @example "users"
  */
 export const DB_COLLECTION_NAME = 'db.collection.name';
@@ -2908,7 +2906,7 @@ export type GRAPHQL_OPERATION_TYPE_TYPE = string;
  *
  * Aliases: {@link CLIENT_ADDRESS} `client.address`
  *
- * @deprecated Use {@link HTTP_CLIENT_IP} (http.client_ip) instead
+ * @deprecated Use {@link CLIENT_ADDRESS} (client.address) instead
  * @example "example.com"
  */
 export const HTTP_CLIENT_IP = 'http.client_ip';
@@ -3322,7 +3320,7 @@ export type HTTP_REQUEST_SECURE_CONNECTION_START_TYPE = number;
  *
  * Attribute defined in OTEL: Yes
  *
- * Aliases: {@link HTTP_RESPONSE_CONTENT_LENGTH} `http.response_content_length`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`, {@link HTTP_RESPONSE_HEADER['CONTENT_LENGTH']} `http.response.header['content-length']`
+ * Aliases: {@link HTTP_RESPONSE_CONTENT_LENGTH} `http.response_content_length`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`
  *
  * @example 123
  */
@@ -3432,7 +3430,7 @@ export type HTTP_RESPONSE_STATUS_CODE_TYPE = number;
  *
  * Attribute defined in OTEL: Yes
  *
- * Aliases: {@link HTTP_RESPONSE_BODY_SIZE} `http.response.body.size`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`, {@link HTTP_RESPONSE_HEADER['CONTENT_LENGTH']} `http.response.header['content-length']`
+ * Aliases: {@link HTTP_RESPONSE_BODY_SIZE} `http.response.body.size`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`
  *
  * @deprecated Use {@link HTTP_RESPONSE_BODY_SIZE} (http.response.body.size) instead
  * @example 123
@@ -5389,8 +5387,6 @@ export type SENTRY_MODULE_KEY_TYPE = string;
  *
  * Attribute defined in OTEL: No
  *
- * Aliases: {@link SENTRY_NEXTJS_FUNCTION_ROUTE} `sentry.nextjs.function.route`
- *
  * @example "/posts/[id]/layout"
  */
 export const SENTRY_NEXTJS_SSR_FUNCTION_ROUTE = 'sentry.nextjs.ssr.function.route';
@@ -5411,8 +5407,6 @@ export type SENTRY_NEXTJS_SSR_FUNCTION_ROUTE_TYPE = string;
  *
  * Attribute defined in OTEL: No
  *
- * Aliases: {@link SENTRY_NEXTJS_FUNCTION_TYPE} `sentry.nextjs.function.type`
- *
  * @example "generateMetadata"
  */
 export const SENTRY_NEXTJS_SSR_FUNCTION_TYPE = 'sentry.nextjs.ssr.function.type';

model/attributes/client/client__address.json

@@ -7,5 +7,5 @@
   },
   "is_in_otel": true,
   "example": "example.com",
-  "alias": ["http.client_id"]
+  "alias": ["http.client_ip"]
 }

model/attributes/db/db__collection__name.json

@@ -6,6 +6,5 @@
     "key": "false"
   },
   "is_in_otel": true,
-  "example": "users",
-  "alias": ["db.collection"]
+  "example": "users"
 }

model/attributes/http/http__client_ip.json

@@ -9,7 +9,7 @@
   "example": "example.com",
   "deprecation": {
     "_status": null,
-    "replacement": "http.client_ip"
+    "replacement": "client.address"
   },
   "alias": ["client.address"]
 }

model/attributes/http/http__response__body__size.json

@@ -7,9 +7,5 @@
   },
   "is_in_otel": true,
   "example": 123,
-  "alias": [
-    "http.response_content_length",
-    "http.response.header.content-length",
-    "http.response.header['content-length']"
-  ]
+  "alias": ["http.response_content_length", "http.response.header.content-length"]
 }

model/attributes/http/http__response_content_length.json

@@ -11,5 +11,5 @@
     "_status": "backfill",
     "replacement": "http.response.body.size"
   },
-  "alias": ["http.response.body.size", "http.response.header.content-length", "http.response.header['content-length']"]
+  "alias": ["http.response.body.size", "http.response.header.content-length"]
 }

model/attributes/sentry/sentry__nextjs__ssr__function__route.json

@@ -7,6 +7,5 @@
   },
   "is_in_otel": false,
   "example": "/posts/[id]/layout",
-  "alias": ["sentry.nextjs.function.route"],
   "sdks": ["javascript"]
 }

model/attributes/sentry/sentry__nextjs__ssr__function__type.json

@@ -7,6 +7,5 @@
   },
   "is_in_otel": false,
   "example": "generateMetadata",
-  "alias": ["sentry.nextjs.function.type"],
   "sdks": ["javascript"]
 }

scripts/generate_attribute_docs.ts

@@ -1,24 +1,7 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 
-interface AttributeJson {
-  key: string;
-  brief: string;
-  has_dynamic_suffix?: boolean;
-  type: 'string' | 'boolean' | 'integer' | 'double' | 'string[]' | 'boolean[]' | 'integer[]' | 'double[]';
-  pii: {
-    key: 'true' | 'maybe' | 'false';
-    reason?: string;
-  };
-  is_in_otel: boolean;
-  example?: string | boolean | number | string[] | boolean[] | number[];
-  deprecation?: {
-    replacement: string;
-    reason?: string;
-  };
-  alias?: string[];
-  sdks?: string[];
-}
+import type { AttributeJson } from './types';
 
 // Function to read and parse a JSON file
 function readJsonFile(filePath: string): AttributeJson {

scripts/generate_attributes.ts

@@ -1,24 +1,6 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-
-interface AttributeJson {
-  key: string;
-  brief: string;
-  has_dynamic_suffix?: boolean;
-  type: 'string' | 'boolean' | 'integer' | 'double' | 'string[]' | 'boolean[]' | 'integer[]' | 'double[]';
-  pii: {
-    key: 'true' | 'maybe' | 'false';
-    reason?: string;
-  };
-  is_in_otel: boolean;
-  example?: string | boolean | number | string[] | boolean[] | number[];
-  deprecation?: {
-    replacement: string;
-    reason?: string;
-  };
-  alias?: string[];
-  sdks?: string[];
-}
+import type { AttributeJson } from './types';
 
 export async function generateAttributes() {
   const attributesDir = path.join(__dirname, '..', 'model', 'attributes');

scripts/generate_deprecated_attributes_json.ts

@@ -1,26 +1,7 @@
 import { execSync } from 'node:child_process';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-
-interface AttributeJson {
-  key: string;
-  brief: string;
-  has_dynamic_suffix?: boolean;
-  type: 'string' | 'boolean' | 'integer' | 'double' | 'string[]' | 'boolean[]' | 'integer[]' | 'double[]';
-  pii: {
-    key: 'true' | 'maybe' | 'false';
-    reason?: string;
-  };
-  is_in_otel: boolean;
-  example?: string | boolean | number | string[] | boolean[] | number[];
-  deprecation?: {
-    replacement: string;
-    reason?: string;
-    _status?: string;
-  };
-  alias?: string[];
-  sdks?: string[];
-}
+import type { AttributeJson } from './types';
 
 // Function to read and parse a JSON file
 function readJsonFile(filePath: string): AttributeJson {

scripts/types.ts

@@ -0,0 +1,19 @@
+export interface AttributeJson {
+  key: string;
+  brief: string;
+  has_dynamic_suffix?: boolean;
+  type: 'string' | 'boolean' | 'integer' | 'double' | 'string[]' | 'boolean[]' | 'integer[]' | 'double[]';
+  pii: {
+    key: 'true' | 'maybe' | 'false';
+    reason?: string;
+  };
+  is_in_otel: boolean;
+  example?: string | boolean | number | string[] | boolean[] | number[];
+  deprecation?: {
+    replacement: string;
+    reason?: string;
+    _status?: string;
+  };
+  alias?: string[];
+  sdks?: string[];
+}

scripts/utils.ts

@@ -0,0 +1,10 @@
+export function attributeKeyToFileName(key: string): string {
+  return key.replace('<key>', '[key]').split('.').join('__').concat('.json');
+}
+
+export function fileNameToAttributeKey(fileName: string): string {
+  return fileName
+    .replace(/\.json$/, '')
+    .replaceAll('__', '.')
+    .replace('[key]', '<key>');
+}

shared/deprecated_attributes.json

@@ -608,7 +608,7 @@
       "example": "example.com",
       "deprecation": {
         "_status": null,
-        "replacement": "http.client_ip"
+        "replacement": "client.address"
       },
       "alias": ["client.address"]
     },
@@ -671,11 +671,7 @@
         "_status": "backfill",
         "replacement": "http.response.body.size"
       },
-      "alias": [
-        "http.response.body.size",
-        "http.response.header.content-length",
-        "http.response.header['content-length']"
-      ]
+      "alias": ["http.response.body.size", "http.response.header.content-length"]
     },
     {
       "key": "http.response_transfer_size",