@sentry/utils
Advanced tools
Package description
The @sentry/utils package provides a collection of utility functions and classes that are used across the Sentry JavaScript SDK. These utilities help with various tasks such as data manipulation, browser and node environment checks, and integration with Sentry's error tracking and performance monitoring features.
Data Manipulation
Provides utility functions for checking data types and manipulating data. For example, the `isString` function can be used to check if a variable is a string.
import { isString } from '@sentry/utils';
function logMessage(message) {
if (isString(message)) {
console.log(message);
} else {
console.log('Not a string');
}
}Environment Checks
Includes functions to check the current runtime environment, such as whether the code is running in a browser or Node.js environment. This is useful for writing isomorphic code that runs both on the client and server.
import { isNodeEnv } from '@sentry/utils';
if (isNodeEnv()) {
console.log('Running in a Node environment');
} else {
console.log('Not running in a Node environment');
}Integration Helpers
Provides functions and classes to help integrate with Sentry, including adding global event processors that can modify or filter events before they are sent to Sentry.
import { addGlobalEventProcessor } from '@sentry/utils';
addGlobalEventProcessor(event => {
// Modify the event object or return null to skip sending the event
return event;
});Lodash is a comprehensive utility library offering a wide array of functions for tasks like data manipulation, array and object operations, and more. While it doesn't provide direct integrations with error tracking systems, its broad utility function set makes it a versatile tool for many of the same data manipulation tasks as @sentry/utils.
The debug package is used for logging debug messages in a development environment. It doesn't offer the same utility functions or Sentry integration as @sentry/utils, but it's useful for debugging applications in development, similar to how one might use Sentry's logging and error tracking in production.
Changelog
8.0.0-alpha.1
This is the first Alpha release of the v8 cycle, which includes a variety of breaking changes.
Read the in-depth migration guide to find out how to address any breaking changes in your code.
- feat(node): Make @sentry/node powered by OpenTelemetry (#10762)
The biggest change is the switch to use OpenTelemetry under the hood in @sentry/node. This brings with it a variety of
changes:
autoDiscoverNodePerformanceMonitoringIntegrations() anymore.Sentry.init() before you import any other packages. Otherwise, the packages cannot be
instrumented:const Sentry = require('@sentry/node');
Sentry.init({
dsn: '...',
// ... other config here
});
// now require other things below this!
const http = require('http');
const express = require('express');
// ....
startTransaction and span.startChild() are no longer supported. This is due to the underlying change to
OpenTelemetry powered performance instrumentation. See
docs on the new performance APIs for details.Related changes:
defaultStackParser & getSentryRelease (#10722)errorHandler (#10728)forceTransaction in OTEL (#10807)isInitialized (#10607)errorHandler to expressErrorHandler (#10746)- feat: Remove @sentry/integrations package (#10799)
This package is no longer published. You can instead import these pluggable integrations directly from your SDK package
(e.g. @sentry/browser or @sentry/react).
- feat: Remove @sentry/hub package (#10783)
This package is no longer published. You can instead import directly from your SDK package (e.g. @sentry/react or
@sentry/node).
- feat(v8): Remove @sentry/tracing (#10625)
This package is no longer published. You can instead import directly from your SDK package (e.g. @sentry/react or
@sentry/node).
- feat: Set required node version to >=14.8.0 for all packages (#10834)
The minimum required node version is now 14.8+. If you need support for older node versions, you can stay on the v7 branch.
- Removed class-based integrations
We have removed most of the deprecated class-based integrations. Instead, you can use the functional styles:
import * as Sentry from '@sentry/browser';
// v7
Sentry.init({
integrations: [new Sentry.BrowserTracing()],
});
// v8
Sentry.init({
integrations: [new Sentry.browserTracingIntegration()],
});
BrowserTracing (#10653)- feat(v8/browser): Remove XHR transport (#10703)
We have removed the XHR transport, and are instead using the fetch-based transport now by default. This means that if you are using Sentry in a browser environment without fetch, you'll need to either provide a fetch polyfill, or provide a custom transport to Sentry.
- feat(sveltekit): Update @sentry/vite-plugin to 2.x and adjust options API (#10813)
We have updated @sentry/sveltekit to use the latest version of @sentry/vite-plugin, which lead to changes in
configuration options.
withActiveSpan is exported everywhere (#10878)null to withActiveSpan (#10717)hub from global, hub.run & hub utilities (#10718)getIsolationScope and getGlobalScope (#10658)setXXX methods set on isolation scope (#10678)addBreadcrumb write to the isolation scope instead of current scope (#10586)addEventProcessor to add to isolation scope (#10606)Sentry.addBreadcrumb to skip hub (#10601)TextEncoder and TextDecoder (#10701)captureConsoleIntegration (#10744)BaseClient (#10789)exports field to package.json (#10569)captureContext function (#10735)webpack:// prefix more broadly from source map sources field (#10642)worker_threads and fix node v14 types (#10791)null and undefined (#10821)? for anonymous function name (#10732)on and emit required on client (#10603)Span class to SentrySpan (#10687)captureXXX methods (#10688)number as span traceFlag (#10855)status field from Span (#10856)@remix-run/router a dependency. (#10479)beforeAddBreadcrumb hook instead of scope listener (#10600)We have also removed or updated a variety of deprecated APIs.
extractTraceparentData export (#10559)span.isSuccess method (#10699)traceHeaders method (#10776)_eventFromIncompleteOnError usage (#10553)browserApiErrorsIntegration (#10755)Span interface (#10854)setupOnce optional in integrations (#10729)makeMain usage (#10713)scope.applyToEvent() method (#10842)lastEventId (#10585)reuseExisting option for ACS (#10645)tracingOrigins options (#10614)showReportDialog APIs (#10609)Readme
Common utilities used by the Sentry JavaScript SDKs.
Note: This package is only meant to be used internally, and as such is not part of our public API contract and does not follow semver.
FAQs
Utilities for all Sentry JavaScript SDKs
The npm package @sentry/utils receives a total of 9,997,845 weekly downloads. As such, @sentry/utils popularity was classified as popular.
We found that @sentry/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.