From c4da4c0d28ebb25c01b2fee278cba8a3ebc2391e Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 2 Apr 2025 14:44:23 +0200 Subject: [PATCH 1/4] feat(develop): Add page context --- .../data-model/event-payloads/contexts.mdx | 38 ++++++++++++++++++- .../sdk/data-model/event-payloads/request.mdx | 5 +-- 2 files changed, 39 insertions(+), 4 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 33d1b404cb02e..139bd43c22407 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -778,6 +778,42 @@ envelope endpoint. } ``` +## Page Context + +Page context contains information about the page that the event occurred on. + +`url` + +: **Required.** The URL of the page that the event occurred on. + +- Example: `https://sentry.io/issues?page=1` + +`user_agent` + +: _Optional_. The user agent of the page that the event occurred on. + +- Example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36` + +`referer` + +: _Optional_. The referer of the page that the event occurred on. + +- Example: `https://sentry.io/` + +### Example Page Context + +```json +{ + "contexts": { + "page": { + "url": "https://sentry.io/issues?page=1", + "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", + "referer": "https://sentry.io/" + } + } +} +``` + ## Response Context Response context contains information about the HTTP response associated with the event. @@ -829,7 +865,7 @@ The required field is `package` which should contain the package or framework wh "contexts": { "missing_instrumentation": { "package": "express", - "javascript.is_cjs": true, + "javascript.is_cjs": true } } } diff --git a/develop-docs/sdk/data-model/event-payloads/request.mdx b/develop-docs/sdk/data-model/event-payloads/request.mdx index 7ebcb51c7897f..86ac063f29ad5 100644 --- a/develop-docs/sdk/data-model/event-payloads/request.mdx +++ b/develop-docs/sdk/data-model/event-payloads/request.mdx @@ -4,9 +4,8 @@ sidebar_order: 8 --- The Request interface contains information on a HTTP request related to the -event. In client SDKs, this can be an outgoing request, or the request that -rendered the current web page. On server SDKs, this could be the incoming web -request that is being handled. +event. In client SDKs, this can be an outgoing request (use the [page context](../contexts/#page-context) to track the page that the request was made from). +On server SDKs, this could be the incoming web request that is being handled. The data variable should only contain the request body (not the query string). It can either be a dictionary (for standard HTTP requests) or a raw request From 30cd7a61f9d69933fc0d88e0aa2c6a1f71d51923 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 2 Apr 2025 15:56:39 +0200 Subject: [PATCH 2/4] update fields, remove user_agent --- .../data-model/event-payloads/contexts.mdx | 30 ++++++++++++++----- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 139bd43c22407..b1c43427c3692 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -782,17 +782,29 @@ envelope endpoint. Page context contains information about the page that the event occurred on. -`url` +`full.url` -: **Required.** The URL of the page that the event occurred on. +: **Required.** The URL of the page that the event occurred on, including query parameters. -- Example: `https://sentry.io/issues?page=1` +- Example: `https://sentry.io/issues?page=1#123` -`user_agent` +`http.url` -: _Optional_. The user agent of the page that the event occurred on. +: **Required.** The URL of the page that the event occurred on, excluding query parameters. -- Example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36` +- Example: `https://sentry.io/issues` + +`http.query` + +: **Optional.** The query parameters of the page that the event occurred on. + +- Example: `?page=1` + +`http.fragment` + +: **Optional.** The fragment of the page that the event occurred on. + +- Example: `#123` `referer` @@ -806,8 +818,10 @@ Page context contains information about the page that the event occurred on. { "contexts": { "page": { - "url": "https://sentry.io/issues?page=1", - "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36", + "full.url": "https://sentry.io/issues?page=1#123", + "http.url": "https://sentry.io/issues", + "http.query": "?page=1", + "http.fragment": "#123", "referer": "https://sentry.io/" } } From 54e8c068a77e859d6351460da00f885f942420a1 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 2 Apr 2025 16:34:36 +0200 Subject: [PATCH 3/4] fix heading --- develop-docs/sdk/data-model/event-payloads/contexts.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index b1c43427c3692..0013c463fcc74 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -812,7 +812,7 @@ Page context contains information about the page that the event occurred on. - Example: `https://sentry.io/` -### Example Page Context +**Example Page Context** ```json { From 0b466fa99d1c8453dd93693531e254dcff9b1a82 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Fri, 4 Apr 2025 10:40:54 +0200 Subject: [PATCH 4/4] remove full url --- .../sdk/data-model/event-payloads/contexts.mdx | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 0013c463fcc74..c458e28c4a782 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -782,15 +782,9 @@ envelope endpoint. Page context contains information about the page that the event occurred on. -`full.url` +`url` -: **Required.** The URL of the page that the event occurred on, including query parameters. - -- Example: `https://sentry.io/issues?page=1#123` - -`http.url` - -: **Required.** The URL of the page that the event occurred on, excluding query parameters. +: **Required.** The URL of the page that the event occurred on, excluding query parameters & fragment. - Example: `https://sentry.io/issues` @@ -818,8 +812,7 @@ Page context contains information about the page that the event occurred on. { "contexts": { "page": { - "full.url": "https://sentry.io/issues?page=1#123", - "http.url": "https://sentry.io/issues", + "url": "https://sentry.io/issues", "http.query": "?page=1", "http.fragment": "#123", "referer": "https://sentry.io/"