@sentry/utils

What is @sentry/utils?

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.

What are @sentry/utils's main functionalities?

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;
});

Other packages similar to @sentry/utils

lodash

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.

debug

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.

README

Sentry JavaScript SDK Utilities (DEPRECATED)

DEPRECATION NOTICE: The @sentry/utils package is deprecated. All exports have been moved to @sentry/core. Import everything from @sentry/core instead.

Links

• Official SDK Docs
• TypeDoc

General

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.

Changelog

8.42.0

Important Changes

• feat(react): React Router v7 support (library) (#14513)

  This release adds support for React Router v7 (library mode). Check out the docs on how to set up the integration: Sentry React Router v7 Integration Docs

Deprecations

• feat: Warn about source-map generation (#14533)

  In the next major version of the SDK we will change how source maps are generated when the SDK is added to an application. Currently, the implementation varies a lot between different SDKs and can be difficult to understand. Moving forward, our goal is to turn on source maps for every framework, unless we detect that they are explicitly turned off. Additionally, if we end up enabling source maps, we will emit a log message that we did so.

  With this particular release, we are emitting warnings that source map generation will change in the future and we print instructions on how to prepare for the next major.

• feat(nuxt): Deprecate tracingOptions in favor of vueIntegration (#14530)

  Currently it is possible to configure tracing options in two places in the Sentry Nuxt SDK:

  • In Sentry.init()
  • Inside tracingOptions in Sentry.init()

  For tree-shaking purposes and alignment with the Vue SDK, it is now recommended to instead use the newly exported vueIntegration() and its tracingOptions option to configure tracing options in the Nuxt SDK:

  // sentry.client.config.ts
  import * as Sentry from '@sentry/nuxt';
  
  Sentry.init({
    // ...
    integrations: [
      Sentry.vueIntegration({
        tracingOptions: {
          trackComponents: true,
        },
      }),
    ],
  });
  

Other Changes

• feat(browser-utils): Update web-vitals to v4.2.4 (#14439)
• feat(nuxt): Expose vueIntegration (#14526)
• fix(feedback): Handle css correctly in screenshot mode (#14535)