Skip to content

Update Span First Docs #15075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 1, 2025
Merged

Update Span First Docs #15075

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c15b99d
Remove 'parent_span_id' from span protocol example
cleptric Sep 29, 2025
35befac
Add envelop header
cleptric Oct 1, 2025
7c879e6
Add common span attributes
cleptric Oct 1, 2025
bdb16dc
Merge branch 'master' into cleptric-patch-1
cleptric Oct 1, 2025
fb523c8
Merge branch 'master' into cleptric-patch-1
cleptric Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions develop-docs/sdk/telemetry/spans/span-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,26 @@ title: Span Protocol

The SDK must implement a new "span v2" envelope item, which is used to emit spans to Sentry.

## Span v2 Envelope Header

The envelope header must contain the same properties as previously with transactions.
There are no special requirements for the Span v2 envelope header.

```json
{
"sent_at": "2025-02-07T14:16:00Z",
"dsn": "https://e12d836b15bb49d7bbf99e64295d995b@sentry.io/42",
"sdk": {
// ...
},
"trace": {
// ...
}
}
```

Also see [Envelope Headers](/sdk/data-model/envelopes/#headers).

## Span v2 Envelope Item Header

The envelope item header must contain the following properties:
Expand All @@ -29,7 +49,6 @@ The envelope item payload must contain an `items` array with span one and up to
"items": [
{
"trace_id": "6cf173d587eb48568a9b2e12dcfbea52",
"parent_span_id": null,
"span_id": "438f40bd3b4a41ee",
"name": "GET /users",
"status": "ok",
Expand Down Expand Up @@ -148,11 +167,22 @@ Attributes are stored as key-value pairs where each value is an object with type

#### Common Attribute Keys

All attributes mentioned below must be attached to every span being emitted from the SDK, depending on the platform.
Empty attributes must be emitted.

| Attribute Key | Type | Description |
|---------------|------|-------------|
| `sentry.release` | string | The release version of the application |
| `sentry.environment` | string | The environment name (e.g., "production", "staging", "development") |
| `sentry.platform` | string | The platform/language (e.g., "php", "javascript", "python") |
| `sentry.segment.name` | string | The segment name (e.g., "GET /users") |
| `os.name` | string | The operating system name (e.g., "Linux", "Windows", "macOS") |
| `browser.name` | string | The browser name (e.g., "Chrome", "Firefox", "Safari") |
| `user.id` | string | The user ID (gated by `sendDefaultPii`) |
| `user.email` | string | The user email (gated by `sendDefaultPii`) |
| `user.ip_address` | string | The user IP address (gated by `sendDefaultPii`) |
Copy link
Member

@Lms24 Lms24 Oct 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: I assume ip_address is set by relay based on the infer_ip setting in the envelope sdk header?

Copy link
Member Author

@cleptric cleptric Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depends if client or sever sdk.

| `user.username` | string | The user username (gated by `sendDefaultPii`) |
| `thread.id` | string | The thread ID |
| `thread.name` | string | The thread name |
| `sentry.sdk.name` | string | Name of the Sentry SDK (e.g., "sentry.php", "sentry.javascript") |
| `sentry.sdk.version` | string | Version of the Sentry SDK |

Expand Down
Loading