@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
7.94.0
As we're moving closer to the next major version of the SDK, more public APIs were deprecated.
To get a head start on migrating to the replacement APIs, please take a look at our migration guide.
finish on Span interface in favour of end (#10161)getCurrentHub() (#10200)hub.bindClient() & makeMain() (#10188)Span.instrumenter (#10139)Span.isSuccess() in favor of reading span status (#10213)Span.op in favor of op attribute (#10189)Span.spanRecorder (#10199)Span.status (#10208)Span.transaction in favor of getRootSpan (#10134)Transaction.instrumenter (#10162)Transaction.setMeasurement in favor of setMeasurement (#10182)Integrations.X (#10198)Hub (#10124)setName declarations on Transaction and Span (#10164)startTimestamp & endTimestamp (#10192)hub.bindClient() and makeMain() (#10118)op on Span interface (#10217)Transaction integration (#10178)We have added a new ReplayCanvas integration (#10112), which you can add to capture the contents of canvas elements
with Replay.
Just add it in addition to the regular replay integration:
Sentry.init({
integrations: [new Sentry.Replay(), new Sentry.ReplayCanvas()],
});
client.getIntegrationByName() (#10130)client.init() to replace client.setupIntegrations() (#10118)withActiveSpan (#10195)withIsolationScope (#10141)setUser, setTags, setExtras, setTag, setExtra, and setContext to isolation
scope (#10163)withActiveSpan (#10194)SerializedEvent interface (pre v8) (#10240)http.status_code is always a string (#10177)process.argv[1] being undefined (#10155)fetch init headers over fetch input headers (#10176)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 10,059,682 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.