Skip to content

docs(replay): Add traces_by_timestamp field to replay event spec #16602

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

Draft
billyvg wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs(replay): Add traces_by_timestamp field to replay event spec #16602

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions develop-docs/sdk/telemetry/replays.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Replay
description: Session recording protocol for capturing and streaming browser or mobile user sessions to Sentry.
spec_id: sdk/telemetry/replays
spec_version: 1.2.0
spec_version: 1.3.0
spec_status: stable
spec_platforms:
- browser
Expand All @@ -11,6 +11,9 @@ spec_depends_on:
- id: sdk/foundations/transport/envelopes
version: ">=1.0.0"
spec_changelog:
- version: 1.3.0
date: 2026-02-26
summary: Added traces_by_timestamp field for timestamped trace association
- version: 1.2.0
date: 2025-07-30
summary: Added session mode hard limit behavior (stop recording, clear replay_id, remove from scope)
Expand Down Expand Up @@ -103,7 +106,8 @@ A `replay_event` envelope item **MUST** always be sent together with a `replay_r
| `segment_id` | Number | **REQUIRED** | 1.0.0 | The segment identifier, starting at 0. |
| `replay_start_timestamp` | Number | **REQUIRED** (first segment) | 1.0.0 | UNIX timestamp of the start of the replay (in seconds). Only required on the first segment. |
| `urls` | List[String] | **OPTIONAL** | 1.0.0 | List of URLs in order of visitation. |
| `trace_ids` | List[String] | **OPTIONAL** | 1.0.0 | List of trace IDs that occurred during the replay. |
| `trace_ids` | List[String] | **OPTIONAL** | 1.0.0 | List of unique trace IDs that occurred during the segment. |
| `traces_by_timestamp` | List[[Number, String]] | **OPTIONAL** | 1.3.0 | List of `[timestamp, trace_id]` pairs. Each entry is a tuple of the transaction's start timestamp (UNIX seconds) and its trace ID. Provides temporal ordering so Sentry can associate replay events with the correct trace. SDKs **SHOULD** send this alongside `trace_ids` for backwards compatibility. |
| `error_ids` | List[String] | **DEPRECATED** | 1.0.0 | Deprecated. Do not use. |

#### Event Attributes
Expand Down Expand Up @@ -323,6 +327,7 @@ sentry_sdk.init(
"replay_type": "session",
"segment_id": 0,
"trace_ids": ["905aef2282af5fe2ab2c93aa7a340521"],
"traces_by_timestamp": [[1710861501.234, "905aef2282af5fe2ab2c93aa7a340521"]],
"urls": [
"https://sentry.io/issues/",
"https://sentry.io/issues/?project=0&statsPeriod=7d&utc=true"
Expand Down Expand Up @@ -376,6 +381,7 @@ sentry_sdk.init(
"replay_type": "session",
"segment_id": 0,
"trace_ids": ["905aef2282af5fe2ab2c93aa7a340521"],
"traces_by_timestamp": [[1710861501.234, "905aef2282af5fe2ab2c93aa7a340521"]],
"urls": [
"https://sentry.io/issues/",
"https://sentry.io/issues/?project=0&statsPeriod=7d&utc=true"
Expand Down
Loading