feat(node): Add includeServerName option (#16442)

Helps in scenarios where the `server_name` is possible PII (like in electron or node CLI applications).

Author: timfish

packages/node/src/sdk/client.ts

@@ -21,7 +21,11 @@ export class NodeClient extends ServerRuntimeClient<NodeClientOptions> {
   private _logOnExitFlushListener: (() => void) | undefined;
 
   public constructor(options: NodeClientOptions) {
-    const serverName = options.serverName || global.process.env.SENTRY_NAME || os.hostname();
+    const serverName =
+      options.includeServerName === false
+        ? undefined
+        : options.serverName || global.process.env.SENTRY_NAME || os.hostname();
+
     const clientOptions: ServerRuntimeClientOptions = {
       ...options,
       platform: 'node',

packages/node/src/types.ts

@@ -61,6 +61,16 @@ export interface BaseNodeOptions {
    */
   profileLifecycle?: 'manual' | 'trace';
 
+  /**
+   * If set to `false`, the SDK will not automatically detect the `serverName`.
+   *
+   * This is useful if you are using the SDK in a CLI app or Electron where the
+   * hostname might be considered PII.
+   *
+   * @default true
+   */
+  includeServerName?: boolean;
+
   /** Sets an optional server name (device name) */
   serverName?: string;
 

packages/node/test/sdk/client.test.ts

@@ -129,6 +129,18 @@ describe('NodeClient', () => {
       expect(event.server_name).toEqual(os.hostname());
     });
 
+    test('does not add hostname when includeServerName = false', () => {
+      const options = getDefaultNodeClientOptions({});
+      options.includeServerName = false;
+      const client = new NodeClient(options);
+
+      const event: Event = {};
+      const hint: EventHint = {};
+      client['_prepareEvent'](event, hint, currentScope, isolationScope);
+
+      expect(event.server_name).toBeUndefined();
+    });
+
     test("doesn't clobber existing runtime data", () => {
       const options = getDefaultNodeClientOptions({ serverName: 'bar' });
       const client = new NodeClient(options);