Update documentations for electron sourcemaps #29280
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cy-moi
force-pushed
the
congyao/update-doc-for-electron-sourcemaps
branch
from
2969cba to
369fd6d
Compare
Preview links (active after the
|
cy-moi
force-pushed
the
congyao/update-doc-for-electron-sourcemaps
branch
from
369fd6d to
ff404ec
Compare
cy-moi
force-pushed
the
congyao/update-doc-for-electron-sourcemaps
branch
from
ff404ec to
167d050
Compare
Datadog Summary✅ Code Quality ✅ Code Security ✅ Dependencies Was this helpful? Give us feedback! |
brett0000FF
approved these changes
May 12, 2025
| @@ -49,6 +49,7 @@ To install the Datadog Browser SDK to support Electron apps: | |||
| The same-origin policy prevents tracking an application for the same session in which pages load from both local (`file://`) and remote (`http(s)://`). | |||
|
|
|||
| This means that an application that uses Electron to embed a landing page, then later redirects the user to a website hosted on the Internet results in two sessions being created for that user - one for the embedded local files (`file://`) landing part of the application, and one for the remote part (`https://` files available on the internet). | |||
| **Note**: Unminified stack traces are not available when monitoring Electron applications that load embedded local files, when stack traces start with `file://`. To obtain unminified stack traces in this scenario, you must manually overwrite them using the [`beforeSend()` callback][2]. For further assistance, contact [Datadog customer support][5]. | |||
There was a problem hiding this comment.
Suggested change
| **Note**: Unminified stack traces are not available when monitoring Electron applications that load embedded local files, when stack traces start with `file://`. To obtain unminified stack traces in this scenario, you must manually overwrite them using the [`beforeSend()` callback][2]. For further assistance, contact [Datadog customer support][5]. | |
| **Note**: Unminified stack traces are not available when monitoring Electron applications that load embedded local files where stack traces start with `file://`. To obtain unminified stack traces in this scenario, you must manually overwrite them using the [`beforeSend()` callback][2]. For further assistance, contact the [Datadog Support team][5]. |
| @@ -60,3 +61,4 @@ An issue with local storage replication latency between windows can cause a shor | |||
| [2]: /real_user_monitoring/browser/setup/ | |||
| [3]: https://www.electronjs.org/docs/latest/tutorial/process-model#the-renderer-process | |||
| [4]: /real_user_monitoring/explorer/ | |||
| [5]: https://www.datadoghq.com/support/ | |||
There was a problem hiding this comment.
Suggested change
| [5]: https://www.datadoghq.com/support/ | |
| [5]: https://docs.datadoghq.com/help/ |
This is the typical place we send them from the docs for support.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
We don't support unminification for Electron apps hosted in local files due to the stack trace prefix
file://. We should mention this in the public documentation for clarification.Merge instructions
Merge readiness:
For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes