ref: Ensure all aliases have a corresponding file (#106)

lcian · web-flow · commit 02733b008a20 · 2025-09-02T16:47:22.000+02:00
diff --git a/generated/attributes/client.md b/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
 
diff --git a/generated/attributes/db.md b/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
 
diff --git a/generated/attributes/http.md b/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
 
diff --git a/generated/attributes/sentry.md b/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
 
diff --git a/javascript/sentry-conventions/src/attributes.ts b/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';
diff --git a/model/attributes/client/client__address.json b/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"]
 }
diff --git a/model/attributes/db/db__collection__name.json b/model/attributes/db/db__collection__name.json
@@ -6,6 +6,5 @@
     "key": "false"
   },
   "is_in_otel": true,
-  "example": "users",
-  "alias": ["db.collection"]
+  "example": "users"
 }
diff --git a/model/attributes/http/http__client_ip.json b/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"]
 }
diff --git a/model/attributes/http/http__response__body__size.json b/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"]
 }
diff --git a/model/attributes/http/http__response_content_length.json b/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"]
 }
diff --git a/model/attributes/sentry/sentry__nextjs__ssr__function__route.json b/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"]
 }
diff --git a/model/attributes/sentry/sentry__nextjs__ssr__function__type.json b/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"]
 }
diff --git a/scripts/generate_attribute_docs.ts b/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 {
diff --git a/scripts/generate_attributes.ts b/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');
diff --git a/scripts/generate_deprecated_attributes_json.ts b/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 {
diff --git a/scripts/types.ts b/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[];
+}
diff --git a/scripts/utils.ts b/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>');
+}
diff --git a/shared/deprecated_attributes.json b/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",
diff --git a/test/attributes.test.ts b/test/attributes.test.ts

Original file line number	Diff line number	Diff line change
`@@ -979,7 +979,7 @@ export type CHANNEL_TYPE = string;`
`979`	`979`	`*`
`980`	`980`	`* Attribute defined in OTEL: Yes`
`981`	`981`	`*`
`982`		- * Aliases: {@link HTTP_CLIENT_ID} `http.client_id`
	`982`	+ * Aliases: {@link HTTP_CLIENT_IP} `http.client_ip`
`983`	`983`	`*`
`984`	`984`	`* @example "example.com"`
`985`	`985`	`*/`
`@@ -1237,8 +1237,6 @@ export type CODE_NAMESPACE_TYPE = string;`
`1237`	`1237`	`*`
`1238`	`1238`	`* Attribute defined in OTEL: Yes`
`1239`	`1239`	`*`
`1240`		- * Aliases: {@link DB_COLLECTION} `db.collection`
`1241`		`- *`
`1242`	`1240`	`* @example "users"`
`1243`	`1241`	`*/`
`1244`	`1242`	`export const DB_COLLECTION_NAME = 'db.collection.name';`
`@@ -2908,7 +2906,7 @@ export type GRAPHQL_OPERATION_TYPE_TYPE = string;`
`2908`	`2906`	`*`
`2909`	`2907`	* Aliases: {@link CLIENT_ADDRESS} `client.address`
`2910`	`2908`	`*`
`2911`		`- * @deprecated Use {@link HTTP_CLIENT_IP} (http.client_ip) instead`
	`2909`	`+ * @deprecated Use {@link CLIENT_ADDRESS} (client.address) instead`
`2912`	`2910`	`* @example "example.com"`
`2913`	`2911`	`*/`
`2914`	`2912`	`export const HTTP_CLIENT_IP = 'http.client_ip';`
`@@ -3322,7 +3320,7 @@ export type HTTP_REQUEST_SECURE_CONNECTION_START_TYPE = number;`
`3322`	`3320`	`*`
`3323`	`3321`	`* Attribute defined in OTEL: Yes`
`3324`	`3322`	`*`
`3325`		- * 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']`
	`3323`	+ * Aliases: {@link HTTP_RESPONSE_CONTENT_LENGTH} `http.response_content_length`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`
`3326`	`3324`	`*`
`3327`	`3325`	`* @example 123`
`3328`	`3326`	`*/`
`@@ -3432,7 +3430,7 @@ export type HTTP_RESPONSE_STATUS_CODE_TYPE = number;`
`3432`	`3430`	`*`
`3433`	`3431`	`* Attribute defined in OTEL: Yes`
`3434`	`3432`	`*`
`3435`		- * 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']`
	`3433`	+ * Aliases: {@link HTTP_RESPONSE_BODY_SIZE} `http.response.body.size`, {@link HTTP_RESPONSE_HEADER_CONTENT_LENGTH} `http.response.header.content-length`
`3436`	`3434`	`*`
`3437`	`3435`	`* @deprecated Use {@link HTTP_RESPONSE_BODY_SIZE} (http.response.body.size) instead`
`3438`	`3436`	`* @example 123`
`@@ -5389,8 +5387,6 @@ export type SENTRY_MODULE_KEY_TYPE = string;`
`5389`	`5387`	`*`
`5390`	`5388`	`* Attribute defined in OTEL: No`
`5391`	`5389`	`*`
`5392`		- * Aliases: {@link SENTRY_NEXTJS_FUNCTION_ROUTE} `sentry.nextjs.function.route`
`5393`		`- *`
`5394`	`5390`	`* @example "/posts/[id]/layout"`
`5395`	`5391`	`*/`
`5396`	`5392`	`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;`
`5411`	`5407`	`*`
`5412`	`5408`	`* Attribute defined in OTEL: No`
`5413`	`5409`	`*`
`5414`		- * Aliases: {@link SENTRY_NEXTJS_FUNCTION_TYPE} `sentry.nextjs.function.type`
`5415`		`- *`
`5416`	`5410`	`* @example "generateMetadata"`
`5417`	`5411`	`*/`
`5418`	`5412`	`export const SENTRY_NEXTJS_SSR_FUNCTION_TYPE = 'sentry.nextjs.ssr.function.type';`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,5 @@`
`7`	`7`	`},`
`8`	`8`	`"is_in_otel": true,`
`9`	`9`	`"example": "example.com",`
`10`		`- "alias": ["http.client_id"]`
	`10`	`+ "alias": ["http.client_ip"]`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,5 @@`
`6`	`6`	`"key": "false"`
`7`	`7`	`},`
`8`	`8`	`"is_in_otel": true,`
`9`		`- "example": "users",`
`10`		`- "alias": ["db.collection"]`
	`9`	`+ "example": "users"`
`11`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`"example": "example.com",`
`10`	`10`	`"deprecation": {`
`11`	`11`	`"_status": null,`
`12`		`- "replacement": "http.client_ip"`
	`12`	`+ "replacement": "client.address"`
`13`	`13`	`},`
`14`	`14`	`"alias": ["client.address"]`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,5 @@`
`11`	`11`	`"_status": "backfill",`
`12`	`12`	`"replacement": "http.response.body.size"`
`13`	`13`	`},`
`14`		`- "alias": ["http.response.body.size", "http.response.header.content-length", "http.response.header['content-length']"]`
	`14`	`+ "alias": ["http.response.body.size", "http.response.header.content-length"]`
`15`	`15`	`}`