@sentry/profiling-node 11.0.0 → 11.1.0

package/README.md

@@ -10,43 +10,12 @@
 [![npm dm](https://img.shields.io/npm/dm/@sentry/profiling-node.svg)](https://www.npmjs.com/package/@sentry/profiling-node)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/profiling-node.svg)](https://www.npmjs.com/package/@sentry/profiling-node)
 
-## Installation
+Profiling for Node.js applications.
 
-Profiling works as an extension of tracing so you will need both @sentry/node and @sentry/profiling-node installed.
+## Documentation
 
-```bash
-# Using yarn
-yarn add @sentry/node @sentry/profiling-node
-
-# Using npm
-npm install --save @sentry/node @sentry/profiling-node
-```
-
-## Usage
-
-```javascript
-import * as Sentry from '@sentry/node';
-import { nodeProfilingIntegration } from '@sentry/profiling-node';
-
-Sentry.init({
-  dsn: 'https://7fa19397baaf433f919fbe02228d5470@o1137848.ingest.sentry.io/6625302',
-  debug: true,
-  tracesSampleRate: 1,
-  profileSessionSampleRate: 1,
-  profileLifecycle: 'trace',
-  integrations: [nodeProfilingIntegration()],
-});
-```
-
-The Sentry SDK will now collect profile chunks while spans are active, including spans started by automatic instrumentation.
-
-```javascript
-Sentry.startSpan({ name: 'some workflow' }, () => {
-  // The code in here will be profiled
-});
-```
-
-With `profileLifecycle: 'manual'` (the default), you can start and stop the profiler by calling `Sentry.profiler.startProfiler()` and `Sentry.profiler.stopProfiler()`.
+- [Getting started](https://docs.sentry.io/platforms/javascript/guides/node/profiling/)
+- [Configuration](https://docs.sentry.io/platforms/javascript/guides/node/profiling/#enabling-profiling)
 
 ### Building the package from source
 
@@ -55,19 +24,16 @@ from source. The libraries required to successfully build the package from sourc
 already required to build any other package which uses native modules and if your codebase uses any of those modules,
 there is a fairly good chance this will work out of the box. The required packages are python, make and g++.
 
-**Windows:** If you are building on windows, you may need to install windows-build-tools
+**Windows:** If you are building on windows, you may need to install Visual Studio's C++ build tools.
 
-**_Python:_** Python 3.12 is not supported yet so you will need a version of python that is lower than 3.12
-
-```bash
+**macOS:** Install Xcode Command Line Tools for the compiler and make.
 
-# using yarn package manager
-yarn global add windows-build-tools
-# or npm package manager
-npm i -g windows-build-tools
-```
+See the [node-gyp prerequisites](https://github.com/nodejs/node-gyp#installation) for supported Python versions and
+platform-specific requirements.
 
-After you have installed the toolchain, you should be able to build the binaries from source
+After you have installed the toolchain, you should be able to build the binaries from source.
+The native bindings are maintained in the [Node CPU profiler repository](https://github.com/getsentry/sentry-javascript-profiling-node-binaries).
+Clone that repository, install its dependencies with `yarn install --ignore-scripts`, and run the following from its root:
 
 ```bash
 # configure node-gyp using yarn
@@ -81,206 +47,20 @@ yarn build:bindings
 npm run build:bindings
 ```
 
-After the binaries are built, you should see them inside the profiling-node/lib folder.
+After the binaries are built, you should see them inside that repository's lib folder.
 
 ### Prebuilt binaries
 
-We currently ship prebuilt binaries for a few of the most common platforms and node versions (v18-24).
+We currently ship prebuilt binaries for a few of the most common platforms and node versions.
 
 - macOS x64
 - Linux ARM64 (musl)
 - Linux x64 (glibc)
 - Windows x64
 
-For a more detailed list, see job_compile_bindings_profiling_node job in our build.yml github action workflow.
-
-### Bundling
-
-If you are looking to squeeze some extra performance or improve cold start in your application (especially true for
-serverless environments where modules are often evaluates on a per request basis), then we recommend you look into
-bundling your code. Modern JS engines are much faster at parsing and compiling JS than following long module resolution
-chains and reading file contents from disk. Because @sentry/profiling-node is a package that uses native node modules,
-bundling it is slightly different than just bundling javascript. In other words, the bundler needs to recognize that a
-.node file is node native binding and move it to the correct location so that it can later be used. Failing to do so
-will result in a MODULE_NOT_FOUND error.
-
-The easiest way to make bundling work with @sentry/profiling-node and other modules which use native nodejs bindings is
-to mark the package as external - this will prevent the code from the package from being bundled, but it means that you
-will now need to rely on the package to be installed in your production environment.
-
-To mark the package as external, use the following configuration:
-
-[Next.js 13+](https://nextjs.org/docs/app/api-reference/next-config-js/serverComponentsExternalPackages)
-
-```js
-const { withSentryConfig } = require('@sentry/nextjs');
-
-/** @type {import('next').NextConfig} */
-const nextConfig = {
-  experimental: {
-    // Add the "@sentry/profiling-node" to serverComponentsExternalPackages.
-    serverComponentsExternalPackages: ['@sentry/profiling-node'],
-  },
-};
-
-module.exports = withSentryConfig(nextConfig, {/* ... */});
-```
-
-[webpack](https://webpack.js.org/configuration/externals/#externals)
-
-```js
-externals: {
-  "@sentry/profiling-node": "commonjs @sentry/profiling-node",
-},
-```
-
-[esbuild](https://esbuild.github.io/api/#external)
-
-```js
-{
-  entryPoints: ['index.js'],
-  platform: 'node',
-  external: ['@sentry/profiling-node'],
-}
-```
-
-[Rollup](https://rollupjs.org/configuration-options/#external)
-
-```js
-{
-  entry: 'index.js',
-  external: '@sentry/profiling-node'
-}
-```
-
-[serverless-esbuild (serverless.yml)](https://www.serverless.com/plugins/serverless-esbuild#external-dependencies)
-
-```yml
-custom:
-  esbuild:
-    external:
-      - @sentry/profiling-node
-    packagerOptions:
-      scripts:
-        - npm install @sentry/profiling-node
-```
-
-[vercel-ncc](https://github.com/vercel/ncc#programmatically-from-nodejs)
-
-```js
-{
-  externals: ["@sentry/profiling-node"],
-}
-```
-
-[vite](https://vitejs.dev/config/ssr-options.html#ssr-external)
-
-```js
-ssr: {
-  external: ['@sentry/profiling-node'];
-}
-```
-
-Marking the package as external is the simplest and most future proof way of ensuring it will work, however if you want
-to bundle it, it is possible to do so as well. Bundling has the benefit of improving your script startup time as all of
-the code is (usually) inside a single executable .js file, which saves time on module resolution.
-
-In general, when attempting to bundle .node native file extensions, you will need to tell your bundler how to treat
-these, as by default it does not know how to handle them. The required approach varies between build tools and you will
-need to find which one will work for you.
-
-The result of bundling .node files correctly is that they are placed into your bundle output directory with their
-require paths updated to reflect their final location.
-
-Example of bundling @sentry/profiling-node with esbuild and .copy loader
-
-```json
-// package.json
-{
-  "scripts": "node esbuild.serverless.js"
-}
-```
-
-```js
-// esbuild.serverless.js
-const { sentryEsbuildPlugin } = require('@sentry/esbuild-plugin');
-
-require('esbuild').build({
-  entryPoints: ['./index.js'],
-  outfile: './dist',
-  platform: 'node',
-  bundle: true,
-  minify: true,
-  sourcemap: true,
-  // This is no longer necessary
-  // external: ["@sentry/profiling-node"],
-  loader: {
-    // ensures .node binaries are copied to ./dist
-    '.node': 'copy',
-  },
-  plugins: [
-    // See https://docs.sentry.io/platforms/javascript/sourcemaps/uploading/esbuild/
-    sentryEsbuildPlugin({
-      project: '',
-      org: '',
-      authToken: '',
-      release: '',
-      sourcemaps: {
-        // Specify the directory containing build artifacts
-        assets: './dist/**',
-      },
-    }),
-  ],
-});
-```
-
-Once you run `node esbuild.serverless.js` esbuild wil bundle and output the files to ./dist folder, but note that all of
-the binaries will be copied. This is wasteful as you will likely only need one of these libraries to be available during
-runtime. Since the binaries follow the `sentry_cpu_profiler-<platform>-<arch>-<stdlib>-<abi>.node` naming scheme, you can
-delete the ones that do not match your target runtime as part of your build step to reduce the deployment size.
-
-### Environment flags
-
-The default mode of the v8 CpuProfiler is kEagerLoggin which enables the profiler even when no profiles are active -
-this is good because it makes calls to startProfiling fast at the tradeoff for constant CPU overhead. The behavior can
-be controlled via the `SENTRY_PROFILER_LOGGING_MODE` environment variable with values of `eager|lazy`. If you opt to use
-the lazy logging mode, calls to startProfiling may be slow (depending on environment and node version, it can be in the
-order of a few hundred ms).
-
-Example of starting a server with lazy logging mode.
-
-```javascript
-SENTRY_PROFILER_LOGGING_MODE=lazy node server.js
-```
-
-## FAQ 💭
-
-### Can the profiler leak PII to Sentry?
-
-The profiler does not collect function arguments so leaking any PII is unlikely. We only collect a subset of the values
-which may identify the device and os that the profiler is running on (if you are already using tracing, it is likely
-that these values are already being collected by the SDK).
-
-There is one way a profiler could leak pii information, but this is unlikely and would only happen for cases where you
-might be creating or naming functions which might contain pii information such as
-
-```js
-eval('function scriptFor${PII_DATA}....');
-```
-
-In that case it is possible that the function name may end up being reported to Sentry.
-
-### Are worker threads supported?
-
-No. All instances of the profiler are scoped per thread In practice, this means that starting a transaction on thread A
-and delegating work to thread B will only result in sample stacks being collected from thread A. That said, nothing
-should prevent you from starting a transaction on thread B concurrently which will result in two independent profiles
-being sent to the Sentry backend. We currently do not do any correlation between such transactions, but we would be open
-to exploring the possibilities. Please file an issue if you have suggestions or specific use-cases in mind.
+For a more detailed list, see the `job_compile` job in the [native build workflow](https://github.com/getsentry/sentry-javascript-profiling-node-binaries/blob/main/.github/workflows/build.yml).
 
-### How much overhead will this profiler add?
+## Support
 
-The profiler uses the kEagerLogging option by default which trades off fast calls to startProfiling for a small amount
-of constant CPU overhead. If you are using kEagerLogging then the tradeoff is reversed and there will be a small CPU
-overhead while the profiler is not running, but calls to startProfiling could be slow (in our tests, this varies by
-environments and node versions, but could be in the order of a couple 100ms).
+- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
+- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

package/build/esm/package.json

@@ -1 +1 @@
-{"type":"module","version":"11.0.0","sideEffects":false}
+{"type":"module","version":"11.1.0","sideEffects":false}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/profiling-node",
-  "version": "11.0.0",
+  "version": "11.1.0",
   "description": "Official Sentry SDK for Node.js Profiling",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/profiling-node",
@@ -51,8 +51,8 @@
   },
   "dependencies": {
     "@sentry/node-cpu-profiler": "^2.4.4",
-    "@sentry/core": "11.0.0",
-    "@sentry/node": "11.0.0"
+    "@sentry/core": "11.1.0",
+    "@sentry/node": "11.1.0"
   },
   "devDependencies": {
     "@types/node": "^18.19.1"