feat(attributes): Add sentry.category attribute

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 - feat(ai): Add gen_ai.usage.input_tokens.cache_write ([#217](https://github.com/getsentry/sentry-conventions/pull/217))
 - feat(attributes): Add sentry.normalized_db_query.hash ([#200](https://github.com/getsentry/sentry-conventions/pull/200))
+- feat(attributes): Add sentry.category attribute ([#218](https://github.com/getsentry/sentry-conventions/pull/218))
 
 ## 0.3.1
 

generated/attributes/all.md

@@ -4,7 +4,7 @@
 
 This page lists all available attributes across all categories.
 
-Total attributes: 414
+Total attributes: 415
 
 ## Stable Attributes
 
@@ -239,6 +239,7 @@ Total attributes: 414
 | [`rpc.service`](./rpc.md#rpcservice) | The full (logical) name of the service being called, including its package name, if applicable. |
 | [`sentry.action`](./sentry.md#sentryaction) | Used as a generic attribute representing the action depending on the type of span. For instance, this is the database query operation for DB spans, and the request method for HTTP spans. |
 | [`sentry.cancellation_reason`](./sentry.md#sentrycancellation_reason) | The reason why a span ended early. |
+| [`sentry.category`](./sentry.md#sentrycategory) | The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'. |
 | [`sentry.client_sample_rate`](./sentry.md#sentryclient_sample_rate) | Rate at which a span was sampled in the SDK. |
 | [`sentry.description`](./sentry.md#sentrydescription) | The human-readable description of a span. |
 | [`sentry.dist`](./sentry.md#sentrydist) | The sentry dist. |

generated/attributes/sentry.md

@@ -5,6 +5,7 @@
 - [Stable Attributes](#stable-attributes)
   - [sentry.action](#sentryaction)
   - [sentry.cancellation_reason](#sentrycancellation_reason)
+  - [sentry.category](#sentrycategory)
   - [sentry.client_sample_rate](#sentryclient_sample_rate)
   - [sentry.description](#sentrydescription)
   - [sentry.dist](#sentrydist)
@@ -79,6 +80,17 @@ The reason why a span ended early.
 | Exists in OpenTelemetry | No |
 | Example | `document.hidden` |
 
+### sentry.category
+
+The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'.
+
+| Property | Value |
+| --- | --- |
+| Type | `string` |
+| Has PII | false |
+| Exists in OpenTelemetry | No |
+| Example | `db` |
+
 ### sentry.client_sample_rate
 
 Rate at which a span was sampled in the SDK.

javascript/sentry-conventions/src/attributes.ts

@@ -6258,6 +6258,26 @@ export const SENTRY_CANCELLATION_REASON = 'sentry.cancellation_reason';
  */
 export type SENTRY_CANCELLATION_REASON_TYPE = string;
 
+// Path: model/attributes/sentry/sentry__category.json
+
+/**
+ * The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'. `sentry.category`
+ *
+ * Attribute Value Type: `string` {@link SENTRY_CATEGORY_TYPE}
+ *
+ * Contains PII: false
+ *
+ * Attribute defined in OTEL: No
+ *
+ * @example "db"
+ */
+export const SENTRY_CATEGORY = 'sentry.category';
+
+/**
+ * Type for {@link SENTRY_CATEGORY} sentry.category
+ */
+export type SENTRY_CATEGORY_TYPE = string;
+
 // Path: model/attributes/sentry/sentry__client_sample_rate.json
 
 /**
@@ -8942,6 +8962,7 @@ export const ATTRIBUTE_TYPE: Record<string, AttributeType> = {
   [SENTRY_BROWSER_NAME]: 'string',
   [SENTRY_BROWSER_VERSION]: 'string',
   [SENTRY_CANCELLATION_REASON]: 'string',
+  [SENTRY_CATEGORY]: 'string',
   [SENTRY_CLIENT_SAMPLE_RATE]: 'double',
   [SENTRY_DESCRIPTION]: 'string',
   [SENTRY_DIST]: 'string',
@@ -9359,6 +9380,7 @@ export type AttributeName =
   | typeof SENTRY_BROWSER_NAME
   | typeof SENTRY_BROWSER_VERSION
   | typeof SENTRY_CANCELLATION_REASON
+  | typeof SENTRY_CATEGORY
   | typeof SENTRY_CLIENT_SAMPLE_RATE
   | typeof SENTRY_DESCRIPTION
   | typeof SENTRY_DIST
@@ -12619,6 +12641,16 @@ export const ATTRIBUTE_METADATA: Record<AttributeName, AttributeMetadata> = {
     isInOtel: false,
     example: 'document.hidden',
   },
+  [SENTRY_CATEGORY]: {
+    brief:
+      "The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'.",
+    type: 'string',
+    pii: {
+      isPii: 'false',
+    },
+    isInOtel: false,
+    example: 'db',
+  },
   [SENTRY_CLIENT_SAMPLE_RATE]: {
     brief: 'Rate at which a span was sampled in the SDK.',
     type: 'double',
@@ -14008,6 +14040,7 @@ export type Attributes = {
   [SENTRY_BROWSER_NAME]?: SENTRY_BROWSER_NAME_TYPE;
   [SENTRY_BROWSER_VERSION]?: SENTRY_BROWSER_VERSION_TYPE;
   [SENTRY_CANCELLATION_REASON]?: SENTRY_CANCELLATION_REASON_TYPE;
+  [SENTRY_CATEGORY]?: SENTRY_CATEGORY_TYPE;
   [SENTRY_CLIENT_SAMPLE_RATE]?: SENTRY_CLIENT_SAMPLE_RATE_TYPE;
   [SENTRY_DESCRIPTION]?: SENTRY_DESCRIPTION_TYPE;
   [SENTRY_DIST]?: SENTRY_DIST_TYPE;

model/attributes/sentry/sentry__category.json

@@ -0,0 +1,10 @@
+{
+  "key": "sentry.category",
+  "brief": "The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'.",
+  "type": "string",
+  "pii": {
+    "key": "false"
+  },
+  "is_in_otel": false,
+  "example": "db"
+}

python/src/sentry_conventions/attributes.py

@@ -3499,6 +3499,16 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
     Example: "document.hidden"
     """
 
+    # Path: model/attributes/sentry/sentry__category.json
+    SENTRY_CATEGORY: Literal["sentry.category"] = "sentry.category"
+    """The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'.
+
+    Type: str
+    Contains PII: false
+    Defined in OTEL: No
+    Example: "db"
+    """
+
     # Path: model/attributes/sentry/sentry__client_sample_rate.json
     SENTRY_CLIENT_SAMPLE_RATE: Literal["sentry.client_sample_rate"] = (
         "sentry.client_sample_rate"
@@ -7108,6 +7118,13 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
         is_in_otel=False,
         example="document.hidden",
     ),
+    "sentry.category": AttributeMetadata(
+        brief="The high-level category of a span, derived from the span operation or span attributes. This categorizes spans by their general purpose (e.g., database, HTTP, UI). Known values include: 'ai', 'ai.pipeline', 'app', 'browser', 'cache', 'console', 'db', 'event', 'file', 'function.aws', 'function.azure', 'function.gcp', 'function.nextjs', 'function.remix', 'graphql', 'grpc', 'http', 'measure', 'middleware', 'navigation', 'pageload', 'queue', 'resource', 'rpc', 'serialize', 'subprocess', 'template', 'topic', 'ui', 'ui.angular', 'ui.ember', 'ui.react', 'ui.svelte', 'ui.vue', 'view', 'websocket'.",
+        type=AttributeType.STRING,
+        pii=PiiInfo(isPii=IsPii.FALSE),
+        is_in_otel=False,
+        example="db",
+    ),
     "sentry.client_sample_rate": AttributeMetadata(
         brief="Rate at which a span was sampled in the SDK.",
         type=AttributeType.DOUBLE,
@@ -8255,6 +8272,7 @@ class ATTRIBUTE_NAMES(metaclass=_AttributeNamesMeta):
         "sentry.browser.name": str,
         "sentry.browser.version": str,
         "sentry.cancellation_reason": str,
+        "sentry.category": str,
         "sentry.client_sample_rate": float,
         "sentry.description": str,
         "sentry.dist": str,