npmpackage.info

Gathering detailed insights and metrics for @sentry/electron

@sentry/electron

The official Sentry SDK for Electron

5.7.0

226

MIT

TypeScript

105.29 kB

18,396,405 6.1

Installations

npm install @sentry/electron

Pull Requests

Open

4

Total

680

Closed

133

Merged

543

Issues

Open

15

Total

340

Closed

325

Releases

111

5.7.0

Published on 31 Oct 2024

5.6.0

Published on 07 Oct 2024

5.5.0

Published on 07 Oct 2024

5.4.0

Published on 27 Aug 2024

5.3.0

Published on 29 Jul 2024

5.2.0

Published on 10 Jul 2024

View all 111 releases

Developer

getsentry

Developer Guide

BETA

Module System

CommonJS, ESM, UMD

Min. Node Version

Typescript Support

Yes

Node Version

20.18.0

NPM Version

10.8.2 Statistics

226 Stars

825 Commits

58 Forks

44 Watching

9 Branches

264 Contributors

Updated on 26 Nov 2024

Bundle Size

332.23 kB

Minified

105.29 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (75.49%)

JavaScript (18.44%)

HTML (5.97%)

Shell (0.1%)

Total Downloads

Cumulative downloads

Total Downloads

18,396,405

Last day

-0.7%

28,974

Compared to previous day

Last week

9.2%

150,465

Compared to previous week

Last month

35.8%

633,297

Compared to previous month

Last year

9.3%

5,440,653

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Official Sentry SDK for Electron

Features

Captures Node errors in the main process (using @sentry/node)
Captures JavaScript errors in renderer processes (using @sentry/browser)
Captures native crashes (Minidump crash reports) from renderers and the main process
Collects breadcrumbs and context information along with events across renderers and the main process
Supports electron >= v15

Usage

To use this SDK, call init(options) as early as possible in the entry modules in the main process as well as all renderer processes or further sub processes you spawn. This will initialize the SDK and hook the environment.

In the Electron main process:

1import { init } from '@sentry/electron/main';
2
3init({
4  dsn: '__DSN__',
5  // ...
6});

In all Electron renderer processes:

1// In the Electron renderer processes
2import { init } from '@sentry/electron/renderer';
3
4init();

If you are using a framework specific Sentry SDK, you can pass that init function as the second parameter in the renderer and the two SDKs functionalities will be combined:

1import { init } from '@sentry/electron/renderer';
2import { init as reactInit } from '@sentry/react';
3
4init({ /* config */ }, reactInit);
5

To set context information or send manual events, use the exported functions of @sentry/electron. Note that these functions will not perform any action before you have called init():

1import * as Sentry from '@sentry/electron/main';
2
3// Set user information, as well as tags and further extras
4const scope = Sentry.getCurrentScope();
5scope.setExtra('battery', 0.7);
6scope.setTag('user_mode', 'admin');
7scope.setUser({ id: '4711' });
8
9// Add a breadcrumb for future events
10Sentry.addBreadcrumb({
11  message: 'My Breadcrumb',
12  // ...
13});
14
15// Capture exceptions, messages or manual events
16Sentry.captureMessage('Hello, world!');
17Sentry.captureException(new Error('Good bye'));
18Sentry.captureEvent({
19  message: 'Manual',
20  stacktrace: [
21    // ...
22  ],
23});

Contributors

Thanks to everyone who contributed to the Sentry Electron SDK!

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

SAST

Determines if the project uses static code analysis.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/new-electron-versions-pr.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-electron-versions-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/new-electron-versions-pr.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-electron-versions-pr.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/new-electron-versions-pr.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-electron-versions-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/new-sdk-versions-pr.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-sdk-versions-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/new-sdk-versions-pr.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-sdk-versions-pr.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/new-sdk-versions-pr.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/new-sdk-versions-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/getsentry/sentry-electron/release.yml/master?enable=pin
Info: 0 out of 18 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

Score

6.1

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@sentry/electron

Installations

Pull Requests

4

680

133

543

Issues

15

340

325

Releases

Developer

Developer Guide

CommonJS, ESM, UMD

Yes

20.18.0

10.8.2

Statistics

Bundle Size

332.23 kB

105.29 kB

Languages

Total Downloads

18,396,405

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Official Sentry SDK for Electron

Features

Usage

Contributors

10

10

10

10

10

9

9

7

0

0

0

0

0

6.1

/10