Refactor SDK logs default attributes to modular, reusable platform includes

Co-authored-by: aprasad <[email protected]>

Author: cursoragent

SDK_LOGS_DEFAULT_ATTRIBUTES_UPDATE.md

@@ -6,68 +6,53 @@ This document summarizes the changes made to update all SDK documentation files
 
 ## Changes Made
 
-### 1. Created Default Attributes Platform Includes
-
-Created a new directory `platform-includes/logs/default-attributes/` with specific files for each SDK:
-
-- **JavaScript SDK** (`javascript.mdx`):
-  - Core attributes: `sentry.environment`, `sentry.release`, `sentry.trace.parent_span_id`, `sentry.sdk.name`, `sentry.sdk.version`
-  - Message template attributes: `sentry.message.template`, `sentry.message.parameter.X`
-  - User attributes: `user.id`, `user.name`, `user.email`
-  - **Browser-specific**: `browser.name`, `browser.version`
-  - **Server-specific**: `server.address`
-
-- **Python SDK** (`python.mdx`):
-  - Core attributes: Standard SDK attributes
-  - Message template attributes: For `{attribute_name}` placeholder syntax
-  - User attributes: Standard user attributes
-  - **Server-specific**: `server.address`
-
-- **PHP SDK** (`php.mdx`):
-  - Core attributes: Standard SDK attributes
-  - Message template attributes: For format specifiers like `%s`
-  - User attributes: Standard user attributes
-  - **Server-specific**: `server.address`
-
-- **Java SDK** (`java.mdx`):
-  - Core attributes: Standard SDK attributes
-  - Message template attributes: For format specifiers like `%s`
-  - User attributes: Standard user attributes
-  - **Server-specific**: `server.address`
-
-- **Ruby SDK** (`ruby.mdx`):
-  - Core attributes: Standard SDK attributes
-  - Message template attributes: For format specifiers like `%s`
-  - User attributes: Standard user attributes
-  - **Server-specific**: `server.address`
-
-- **Android SDK** (`android.mdx`):
-  - Core attributes: Standard SDK attributes with `sentry.java.android` as sdk name
-  - Message template attributes: For format specifiers
-  - User attributes: Standard user attributes
-  - **Mobile-specific**: `os.name`, `os.version`, `device.brand`, `device.model`, `device.family`
-
-- **React Native SDK** (`react-native.mdx`):
-  - Core attributes: Standard SDK attributes with `sentry.javascript.react-native` as sdk name
-  - Message template attributes: For `logger.fmt` or format strings
-  - User attributes: Standard user attributes
-  - **Mobile-specific**: `os.name`, `os.version`, `device.brand`, `device.model`, `device.family`
-
-- **Dart SDK** (`dart.mdx`):
-  - Core attributes: Standard SDK attributes with `sentry.dart` or `sentry.dart.flutter` as sdk name
-  - Message template attributes: For format specifiers
-  - User attributes: Standard user attributes
-  - **Mobile-specific** (Flutter): `os.name`, `os.version`, `device.brand`, `device.model`, `device.family`
-
-- **Rust SDK** (`rust.mdx`):
-  - Core attributes: Standard SDK attributes with `sentry.rust` as sdk name
-  - Message template attributes: For format specifiers
-  - User attributes: Standard user attributes
-  - **Server-specific**: `server.address`
+### 1. Created Modular Default Attributes Platform Includes
+
+Created a new modular structure in `platform-includes/logs/default-attributes/` with separate files for different types of attributes:
+
+#### Core Shared Attributes
+- **`core.mdx`**: Core attributes common to all SDKs
+  - `sentry.environment`, `sentry.release`, `sentry.trace.parent_span_id`, `sentry.sdk.name`, `sentry.sdk.version`
+
+- **`user.mdx`**: User attributes common to all SDKs
+  - `user.id`, `user.name`, `user.email`
+
+- **`browser.mdx`**: Browser-specific attributes
+  - `browser.name`, `browser.version`
+
+- **`server.mdx`**: Server-specific attributes
+  - `server.address`
+
+- **`mobile.mdx`**: Mobile device-specific attributes
+  - `os.name`, `os.version`, `device.brand`, `device.model`, `device.family`
+
+#### Message Template Attributes (SDK-specific)
+- **`message-template/javascript.mdx`**: For `logger.fmt` or format strings
+- **`message-template/python.mdx`**: For `{attribute_name}` placeholder syntax
+- **`message-template/php.mdx`**: For format specifiers like `%s`
+- **`message-template/java.mdx`**: For format specifiers like `%s`
+- **`message-template/ruby.mdx`**: For format specifiers like `%s`
+- **`message-template/android.mdx`**: For format specifiers
+- **`message-template/dart.mdx`**: For format specifiers
+- **`message-template/rust.mdx`**: For format specifiers
+- **`message-template/go.mdx`**: For format specifiers like `%v`
+
+#### SDK-Specific Composition Files
+Each SDK has its own composition file that includes the relevant modular components:
+
+- **`javascript.mdx`**: Includes core + javascript message template + user + browser + server
+- **`python.mdx`**: Includes core + python message template + user + server
+- **`php.mdx`**: Includes core + php message template + user + server
+- **`java.mdx`**: Includes core + java message template + user + server
+- **`ruby.mdx`**: Includes core + ruby message template + user + server
+- **`android.mdx`**: Includes core + android message template + user + mobile
+- **`react-native.mdx`**: Includes core + javascript message template + user + mobile
+- **`dart.mdx`**: Includes core + dart message template + user + mobile
+- **`rust.mdx`**: Includes core + rust message template + user + server
 
 ### 2. Updated SDK Documentation Files
 
-Updated the following SDK documentation files to include the new "Default Attributes" section:
+Updated all SDK documentation files to include the new "Default Attributes" section:
 
 #### Files Using Platform Includes:
 - `docs/platforms/python/logs/index.mdx`
@@ -79,9 +64,29 @@ Updated the following SDK documentation files to include the new "Default Attrib
 - `docs/platforms/react-native/logs/index.mdx`
 - `docs/platforms/dart/guides/flutter/logs/index.mdx`
 
-#### Files with Explicit Content:
-- `docs/platforms/go/common/logs/index.mdx` - Added detailed default attributes section
-- `docs/platforms/rust/common/logs/index.mdx` - Added detailed default attributes section
+#### Files Updated to Use Modular Includes:
+- `docs/platforms/go/common/logs/index.mdx` - Updated to use modular includes
+- `docs/platforms/rust/common/logs/index.mdx` - Updated to use modular includes
+
+## Benefits of Modular Structure
+
+### 1. **Maintainability**
+- Each type of attribute is defined in one place
+- Changes to core attributes affect all SDKs automatically
+- No duplication of common content
+
+### 2. **Consistency**
+- All SDKs use the same definitions for shared attributes
+- Consistent formatting and explanations across all platforms
+
+### 3. **Flexibility**
+- Easy to add new attribute types
+- Simple to customize message template explanations per SDK
+- Easy to compose different attribute sets for different SDK types
+
+### 4. **Reusability**
+- Common attributes can be reused across multiple SDKs
+- Easy to add new SDKs by composing existing modules
 
 ## Default Attributes by SDK Type
 
@@ -115,58 +120,45 @@ Updated the following SDK documentation files to include the new "Default Attrib
 - `device.model`: Model of the device
 - `device.family`: Family of the device
 
+## File Structure
+
+```
+platform-includes/logs/default-attributes/
+├── core.mdx                    # Core attributes (all SDKs)
+├── user.mdx                    # User attributes (all SDKs)
+├── browser.mdx                 # Browser attributes (browser SDKs)
+├── server.mdx                  # Server attributes (backend SDKs)
+├── mobile.mdx                  # Mobile attributes (mobile SDKs)
+├── message-template/           # Message template attributes (SDK-specific)
+│   ├── javascript.mdx          # logger.fmt syntax
+│   ├── python.mdx              # {attribute_name} syntax
+│   ├── php.mdx                 # %s format specifiers
+│   ├── java.mdx                # %s format specifiers
+│   ├── ruby.mdx                # %s format specifiers
+│   ├── android.mdx             # format specifiers
+│   ├── dart.mdx                # format specifiers
+│   ├── rust.mdx                # format specifiers
+│   └── go.mdx                  # %v format specifiers
+├── javascript.mdx              # Composition for JavaScript SDK
+├── python.mdx                  # Composition for Python SDK
+├── php.mdx                     # Composition for PHP SDK
+├── java.mdx                    # Composition for Java SDK
+├── ruby.mdx                    # Composition for Ruby SDK
+├── android.mdx                 # Composition for Android SDK
+├── react-native.mdx            # Composition for React Native SDK
+├── dart.mdx                    # Composition for Dart SDK
+└── rust.mdx                    # Composition for Rust SDK
+```
+
 ## Implementation Details
 
-1. **Attribute Specificity**: Each SDK only mentions attributes relevant to its platform type. For example:
-   - Browser attributes are only mentioned for JavaScript browser SDKs
-   - Mobile device attributes are only mentioned for Android, React Native, and Flutter SDKs
-   - Server attributes are only mentioned for backend SDKs
-
-2. **Message Template Context**: Each SDK's default attributes documentation explains its specific message templating syntax:
-   - JavaScript: `logger.fmt` or format strings
-   - Python: `{attribute_name}` placeholder syntax
-   - PHP/Java/Ruby: Format specifiers like `%s`
-   - Go: Format specifiers like `%v`
-   - Rust: Format syntax
-
-3. **SDK Name Specificity**: Each SDK documents its specific `sentry.sdk.name` value:
-   - JavaScript: `sentry.javascript.browser`, `sentry.javascript.node`, etc.
-   - Python: `sentry.python`
-   - PHP: `sentry.php`
-   - Java: `sentry.java`
-   - Android: `sentry.java.android`
-   - React Native: `sentry.javascript.react-native`
-   - Dart: `sentry.dart` or `sentry.dart.flutter`
-   - Go: `sentry.go`
-   - Ruby: `sentry.ruby`
-   - Rust: `sentry.rust`
+1. **Modular Design**: Each attribute type is defined once and reused across relevant SDKs
+2. **Attribute Specificity**: Each SDK only includes attributes relevant to its platform type
+3. **Message Template Context**: Each SDK has its own message template explanation for its specific syntax
+4. **Consistent Formatting**: All shared attributes use the same formatting and descriptions
 
 ## SDKs Supported
 
-All SDKs listed on the [Logs Getting Started page](https://docs.sentry.io/product/explore/logs/getting-started/) now have default attributes documentation:
-
-### JavaScript (all variants)
-- Browser JavaScript, Angular, Astro, AWS Lambda, Azure Functions, Bun, Cloudflare, Connect, Electron, Ember, Express, Fastify, Gatsby, Google Cloud Functions, Hapi, Hono, Koa, Nest.js, Node.js, Next.js, Nuxt, React, React Router, Remix, Solid, SolidStart, Svelte, SvelteKit, TanStack Start, Vue, Wasm
-
-### Java
-- Java, Spring, Spring Boot
-
-### Mobile
-- Android, Flutter, React Native
-
-### PHP
-- PHP, Laravel
-
-### Python
-- Python
-
-### Ruby
-- Ruby
-
-### Go
-- Go
-
-### Rust
-- Rust
+All SDKs listed on the [Logs Getting Started page](https://docs.sentry.io/product/explore/logs/getting-started/) now have modular default attributes documentation that provides consistent, maintainable information about what attributes will be automatically attached to their log entries.
 
-This ensures that developers using any of these SDKs can now understand exactly what default attributes will be automatically attached to their log entries, helping them make better use of Sentry's structured logging capabilities.
+This modular approach makes it easy to maintain consistency across all SDK documentation while allowing for platform-specific customizations where needed.

docs/platforms/go/common/logs/index.mdx

@@ -132,34 +132,13 @@ We're actively working on adding more integration support for Logs. Currently, w
 
 The Go SDK automatically sets several default attributes on all log entries to provide context and improve debugging:
 
-### Core Attributes
+<Include name="logs/default-attributes/core.mdx" />
 
-- `sentry.environment`: The environment set in the SDK if defined
-- `sentry.release`: The release set in the SDK if defined
-- `sentry.trace.parent_span_id`: The span ID of the span that was active when the log was collected (only set if there was an active span)
-- `sentry.sdk.name`: The name of the SDK that sent the log (`sentry.go`)
-- `sentry.sdk.version`: The version of the SDK that sent the log
+<Include name="logs/default-attributes/message-template/go.mdx" />
 
-### Message Template Attributes
+<Include name="logs/default-attributes/user.mdx" />
 
-If the log was parameterized using format specifiers (like `%v`), the SDK will also set:
-
-- `sentry.message.template`: The parameterized template string
-- `sentry.message.parameter.X`: The parameters to the template string, where X is the parameter's position
-
-### User Attributes
-
-If user information is available in the current scope:
-
-- `user.id`: The user ID
-- `user.name`: The username
-- `user.email`: The email address
-
-### Server Attributes
-
-For backend applications:
-
-- `server.address`: The address of the server that sent the log (equivalent to server_name attached to errors and transactions)
+<Include name="logs/default-attributes/server.mdx" />
 
 ## Options
 

docs/platforms/rust/common/logs/index.mdx

@@ -208,34 +208,13 @@ If you'd like to see support for additional logging libraries, please open a [ne
 
 The Rust SDK automatically sets several default attributes on all log entries to provide context and improve debugging:
 
-### Core Attributes
+<Include name="logs/default-attributes/core.mdx" />
 
-- `sentry.environment`: The environment set in the SDK if defined
-- `sentry.release`: The release set in the SDK if defined
-- `sentry.trace.parent_span_id`: The span ID of the span that was active when the log was collected (only set if there was an active span)
-- `sentry.sdk.name`: The name of the SDK that sent the log (`sentry.rust`)
-- `sentry.sdk.version`: The version of the SDK that sent the log
+<Include name="logs/default-attributes/message-template/rust.mdx" />
 
-### Message Template Attributes
+<Include name="logs/default-attributes/user.mdx" />
 
-If the log was parameterized using format specifiers, the SDK will also set:
-
-- `sentry.message.template`: The parameterized template string
-- `sentry.message.parameter.X`: The parameters to the template string, where X is the parameter's position
-
-### User Attributes
-
-If user information is available in the current scope:
-
-- `user.id`: The user ID
-- `user.name`: The username
-- `user.email`: The email address
-
-### Server Attributes
-
-For backend applications:
-
-- `server.address`: The address of the server that sent the log (equivalent to server_name attached to errors and transactions)
+<Include name="logs/default-attributes/server.mdx" />
 
 ## Options
 

platform-includes/logs/default-attributes/android.mdx

@@ -1,34 +1,9 @@
 The Android SDK automatically sets several default attributes on all log entries to provide context and improve debugging:
 
-### Core Attributes
+<Include name="logs/default-attributes/core.mdx" />
 
-- `sentry.environment`: The environment set in the SDK if defined
-- `sentry.release`: The release set in the SDK if defined
-- `sentry.trace.parent_span_id`: The span ID of the span that was active when the log was collected (only set if there was an active span)
-- `sentry.sdk.name`: The name of the SDK that sent the log (`sentry.java.android`)
-- `sentry.sdk.version`: The version of the SDK that sent the log
+<Include name="logs/default-attributes/message-template/android.mdx" />
 
-### Message Template Attributes
+<Include name="logs/default-attributes/user.mdx" />
 
-If the log was parameterized using format specifiers, the SDK will also set:
-
-- `sentry.message.template`: The parameterized template string
-- `sentry.message.parameter.X`: The parameters to the template string, where X is the parameter's position
-
-### User Attributes
-
-If user information is available in the current scope:
-
-- `user.id`: The user ID
-- `user.name`: The username
-- `user.email`: The email address
-
-### Mobile Device Attributes
-
-For mobile applications:
-
-- `os.name`: The name of the operating system (`Android`)
-- `os.version`: The version of the operating system
-- `device.brand`: The brand of the device (e.g., `Samsung`, `Google`)
-- `device.model`: The model of the device (e.g., `SM-G973F`, `Pixel 5`)
-- `device.family`: The family of the device
+<Include name="logs/default-attributes/mobile.mdx" />

platform-includes/logs/default-attributes/browser.mdx

@@ -0,0 +1,6 @@
+### Browser Attributes
+
+For browser-based applications:
+
+- `browser.name`: Display name of the browser application
+- `browser.version`: Version string of the browser

platform-includes/logs/default-attributes/core.mdx

@@ -0,0 +1,7 @@
+### Core Attributes
+
+- `sentry.environment`: The environment set in the SDK if defined
+- `sentry.release`: The release set in the SDK if defined
+- `sentry.trace.parent_span_id`: The span ID of the span that was active when the log was collected (only set if there was an active span)
+- `sentry.sdk.name`: The name of the SDK that sent the log
+- `sentry.sdk.version`: The version of the SDK that sent the log