Merge branch 'ep/display-changelog-of-attributes-6su' of github.com:getsentry/sentry-conventions into ep/display-changelog-of-attributes-6su

Author: ericapisani

docs/package.json

@@ -15,7 +15,7 @@
     "@astrojs/tailwind": "^6.0.2",
     "astro": "^5.16.15",
     "dompurify": "^3.3.1",
-    "svelte": "^5.51.5",
+    "svelte": "^5.53.5",
     "tailwindcss": "^3.4.0"
   },
   "devDependencies": {

javascript/sentry-conventions/src/attributes.ts

@@ -6331,6 +6331,27 @@ export const REPLAY_ID = 'replay_id';
  */
 export type REPLAY_ID_TYPE = string;
 
+// Path: model/attributes/resource/resource__deployment__environment.json
+
+/**
+ * The software deployment environment name. `resource.deployment.environment`
+ *
+ * Attribute Value Type: `string` {@link RESOURCE_DEPLOYMENT_ENVIRONMENT_TYPE}
+ *
+ * Contains PII: false
+ *
+ * Attribute defined in OTEL: Yes
+ *
+ * @deprecated Use {@link SENTRY_ENVIRONMENT} (sentry.environment) instead
+ * @example "production"
+ */
+export const RESOURCE_DEPLOYMENT_ENVIRONMENT = 'resource.deployment.environment';
+
+/**
+ * Type for {@link RESOURCE_DEPLOYMENT_ENVIRONMENT} resource.deployment.environment
+ */
+export type RESOURCE_DEPLOYMENT_ENVIRONMENT_TYPE = string;
+
 // Path: model/attributes/resource/resource__deployment__environment__name.json
 
 /**
@@ -9256,6 +9277,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   [RELEASE]: 'string',
   [REMIX_ACTION_FORM_DATA_KEY]: 'string',
   [REPLAY_ID]: 'string',
+  [RESOURCE_DEPLOYMENT_ENVIRONMENT]: 'string',
   [RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME]: 'string',
   [RESOURCE_RENDER_BLOCKING_STATUS]: 'string',
   [ROUTE]: 'string',
@@ -9686,6 +9708,7 @@ export type AttributeName =
   | typeof RELEASE
   | typeof REMIX_ACTION_FORM_DATA_KEY
   | typeof REPLAY_ID
+  | typeof RESOURCE_DEPLOYMENT_ENVIRONMENT
   | typeof RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME
   | typeof RESOURCE_RENDER_BLOCKING_STATUS
   | typeof ROUTE
@@ -13445,6 +13468,18 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     aliases: [SENTRY_REPLAY_ID],
     changelog: [{ version: '0.1.0', prs: [61] }, { version: '0.0.0' }],
   },
+  [RESOURCE_DEPLOYMENT_ENVIRONMENT]: {
+    brief: 'The software deployment environment name.',
+    type: 'string',
+    pii: {
+      isPii: 'false',
+    },
+    isInOtel: true,
+    example: 'production',
+    deprecation: {
+      replacement: 'sentry.environment',
+    },
+  },
   [RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME]: {
     brief: 'The software deployment environment name.',
     type: 'string',
@@ -15096,6 +15131,7 @@ export type Attributes = {
   [RELEASE]?: RELEASE_TYPE;
   [REMIX_ACTION_FORM_DATA_KEY]?: REMIX_ACTION_FORM_DATA_KEY_TYPE;
   [REPLAY_ID]?: REPLAY_ID_TYPE;
+  [RESOURCE_DEPLOYMENT_ENVIRONMENT]?: RESOURCE_DEPLOYMENT_ENVIRONMENT_TYPE;
   [RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME]?: RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME_TYPE;
   [RESOURCE_RENDER_BLOCKING_STATUS]?: RESOURCE_RENDER_BLOCKING_STATUS_TYPE;
   [ROUTE]?: ROUTE_TYPE;

model/attributes/resource/resource__deployment__environment.json

@@ -0,0 +1,14 @@
+{
+  "key": "resource.deployment.environment",
+  "brief": "The software deployment environment name.",
+  "type": "string",
+  "pii": {
+    "key": "false"
+  },
+  "is_in_otel": true,
+  "example": "production",
+  "deprecation": {
+    "_status": "backfill",
+    "replacement": "sentry.environment"
+  }
+}

python/src/sentry_conventions/attributes.py

@@ -189,6 +189,7 @@ class _AttributeNamesMeta(type):
         "QUERY_KEY",
         "RELEASE",
         "REPLAY_ID",
+        "RESOURCE_DEPLOYMENT_ENVIRONMENT",
         "RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME",
         "ROUTE",
         "SENTRY_BROWSER_NAME",
@@ -3588,6 +3589,19 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
     Example: "123e4567e89b12d3a456426614174000"
     """
 
+    # Path: model/attributes/resource/resource__deployment__environment.json
+    RESOURCE_DEPLOYMENT_ENVIRONMENT: Literal["resource.deployment.environment"] = (
+        "resource.deployment.environment"
+    )
+    """The software deployment environment name.
+
+    Type: str
+    Contains PII: false
+    Defined in OTEL: Yes
+    DEPRECATED: Use sentry.environment instead
+    Example: "production"
+    """
+
     # Path: model/attributes/resource/resource__deployment__environment__name.json
     RESOURCE_DEPLOYMENT_ENVIRONMENT_NAME: Literal[
         "resource.deployment.environment.name"
@@ -8478,6 +8492,16 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
             ChangelogEntry(version="0.0.0"),
         ],
     ),
+    "resource.deployment.environment": AttributeMetadata(
+        brief="The software deployment environment name.",
+        type=AttributeType.STRING,
+        pii=PiiInfo(isPii=IsPii.FALSE),
+        is_in_otel=True,
+        example="production",
+        deprecation=DeprecationInfo(
+            replacement="sentry.environment", status=DeprecationStatus.BACKFILL
+        ),
+    ),
     "resource.deployment.environment.name": AttributeMetadata(
         brief="The software deployment environment name.",
         type=AttributeType.STRING,
@@ -10119,6 +10143,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
         "release": str,
         "remix.action_form_data.<key>": str,
         "replay_id": str,
+        "resource.deployment.environment": str,
         "resource.deployment.environment.name": str,
         "resource.render_blocking_status": str,
         "route": str,

shared/deprecated_attributes.json

@@ -2156,6 +2156,20 @@
         }
       ]
     },
+    {
+      "key": "resource.deployment.environment",
+      "brief": "The software deployment environment name.",
+      "type": "string",
+      "pii": {
+        "key": "false"
+      },
+      "is_in_otel": true,
+      "example": "production",
+      "deprecation": {
+        "_status": "backfill",
+        "replacement": "sentry.environment"
+      }
+    },
     {
       "key": "resource.deployment.environment.name",
       "brief": "The software deployment environment name.",