@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.43.0

Important Changes

• feat(nuxt): Add option autoInjectServerSentry (no default import()) (#14553)

  Using the dynamic import() as the default behavior for initializing the SDK on the server-side did not work for every project. The default behavior of the SDK has been changed, and you now need to use the --import flag to initialize Sentry on the server-side to leverage full functionality.

  Example with --import:

  node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs
  

  In case you are not able to use the --import flag, you can enable auto-injecting Sentry in the nuxt.config.ts (comes with limitations):

  sentry: {
    autoInjectServerSentry: 'top-level-import', // or 'experimental_dynamic-import'
  },
  

• feat(browser): Adds LaunchDarkly and OpenFeature integrations (#14207)

  Adds browser SDK integrations for tracking feature flag evaluations through the LaunchDarkly JS SDK and OpenFeature Web SDK:

  import * as Sentry from '@sentry/browser';
  
  Sentry.init({
    integrations: [
      // Track LaunchDarkly feature flags
      Sentry.launchDarklyIntegration(),
      // Track OpenFeature feature flags
      Sentry.openFeatureIntegration(),
    ],
  });
  

  • Read more about the Feature Flags feature in Sentry.
  • Read more about the LaunchDarkly SDK Integration.
  • Read more about the OpenFeature SDK Integration.

• feat(browser): Add featureFlagsIntegration for custom tracking of flag evaluations (#14582)

  Adds a browser integration to manually track feature flags with an API. Feature flags are attached to subsequent error events:

  import * as Sentry from '@sentry/browser';
  
  const featureFlagsIntegrationInstance = Sentry.featureFlagsIntegration();
  
  Sentry.init({
    // Initialize the SDK with the feature flag integration
    integrations: [featureFlagsIntegrationInstance],
  });
  
  // Manually track a feature flag
  featureFlagsIntegrationInstance.addFeatureFlag('my-feature', true);
  

• feat(astro): Add Astro 5 support (#14613)

  With this release, the Sentry Astro SDK officially supports Astro 5.

Deprecations

• feat(nextjs): Deprecate typedef for hideSourceMaps (#14594)

  The functionality of hideSourceMaps was removed in version 8 but was forgotten to be deprecated and removed. It will be completely removed in the next major version.

• feat(core): Deprecate APIs around RequestSessions (#14566)

  The APIs around RequestSessions are mostly used internally. Going forward the SDK will not expose concepts around RequestSessions. Instead, functionality around server-side Release Health will be managed in integrations.

Other Changes

• feat(browser): Add browserSessionIntegration (#14551)
• feat(core): Add raw_security envelope types (#14562)
• feat(deps): Bump @opentelemetry/instrumentation from 0.55.0 to 0.56.0 (#14625)
• feat(deps): Bump @sentry/cli from 2.38.2 to 2.39.1 (#14626)
• feat(deps): Bump @sentry/rollup-plugin from 2.22.6 to 2.22.7 (#14622)
• feat(deps): Bump @sentry/webpack-plugin from 2.22.6 to 2.22.7 (#14623)
• feat(nestjs): Add fastify support (#14549)
• feat(node): Add @vercel/ai instrumentation (#13892)
• feat(node): Add disableAnrDetectionForCallback function (#14359)
• feat(node): Add trackIncomingRequestsAsSessions option to http integration (#14567)
• feat(nuxt): Add option autoInjectServerSentry (no default import()) (#14553)
• feat(nuxt): Add warning when Netlify or Vercel build is discovered (#13868)
• feat(nuxt): Improve serverless event flushing and scope isolation (#14605)
• feat(opentelemetry): Stop looking at propagation context for span creation (#14481)
• feat(opentelemetry): Update OpenTelemetry dependencies to ^1.29.0 (#14590)
• feat(opentelemetry): Update OpenTelemetry dependencies to 1.28.0 (#14547)
• feat(replay): Upgrade rrweb packages to 2.30.0 (#14597)
• fix(core): Decode filename and module stack frame properties in Node stack parser (#14544)
• fix(core): Filter out unactionable CEFSharp promise rejection error by default (#14595)
• fix(nextjs): Don't show warning about devtool option (#14552)
• fix(nextjs): Only apply tracing metadata to data fetcher data when data is an object (#14575)
• fix(node): Guard against invalid maxSpanWaitDuration values (#14632)
• fix(react): Match routes with parseSearch option in TanStack Router instrumentation (#14328)
• fix(sveltekit): Fix git SHA not being picked up for release (#14540)
• fix(types): Fix generic exports with default (#14576)

Work in this release was contributed by @lsmurray. Thank you for your contribution!