feat(electron): Document structured logging for the Electron SDK #13925
+33
−6
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
Documents the newly added structured logging feature for the Electron SDK by adding dedicated includes and updating the public-facing docs.
- Introduces platform-includes files for Electron logs (usage, setup, requirements, integrations).
- Adds an Electron entry to the “Getting Started” logs guide.
- Marks Electron as supported by removing it from the common logs
notSupportedlist.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| platform-includes/logs/usage/javascript.electron.mdx | Include usage guide for Electron structured logs |
| platform-includes/logs/setup/javascript.electron.mdx | Add setup instructions and code snippets for main/renderer processes |
| platform-includes/logs/requirements/javascript.electron.mdx | Specify minimum Electron SDK version that supports logging |
| platform-includes/logs/integrations/javascript.electron.mdx | Include console-logging integration guide |
| docs/product/explore/logs/getting-started/index.mdx | Add Electron to supported SDKs list and remove outdated placeholder |
| docs/platforms/javascript/common/logs/index.mdx | Remove Electron from the notSupported list |
Bundle ReportChanges will increase total bundle size by 831 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
timfish
approved these changes
Jun 4, 2025
antonpirker
pushed a commit
that referenced
this pull request
Jun 6, 2025
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.
DESCRIBE YOUR PR
Documents getsentry/sentry-electron#1159
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES