wip but detect tracing config at SDK setup time

Author: Lms24

packages/sveltekit/src/server-common/processKitSpans.ts

@@ -9,6 +9,8 @@ import { type SpanJSON, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_
 export function svelteKitSpansIntegration(): Integration {
   return {
     name: 'SvelteKitSpansEnhancment',
+    // Using preprocessEvent to ensure the processing happens before user-configured
+    // event processors are executed
     preprocessEvent(event) {
       if (event.type === 'transaction') {
         event.spans?.forEach(_enhanceKitSpan);

packages/sveltekit/src/server-common/utils.ts

@@ -1,6 +1,7 @@
-import { captureException, objectify } from '@sentry/core';
+import { captureException, GLOBAL_OBJ, objectify } from '@sentry/core';
 import type { RequestEvent } from '@sveltejs/kit';
 import { isHttpError, isRedirect } from '../common/utils';
+import type { GlobalWithSentryValues } from '../vite/injectGlobalValues';
 
 /**
  * Takes a request event and extracts traceparent and DSC data
@@ -52,3 +53,17 @@ export function sendErrorToSentry(e: unknown, handlerFn: 'handle' | 'load' | 'se
 
   return objectifiedErr;
 }
+
+/**
+ * During build, we inject the SvelteKit tracing config into the global object of the server.
+ * @returns tracing config (available since 2.31.0)
+ */
+export function getKitTracingConfig(): { instrumentation: boolean; tracing: boolean } {
+  const globalWithSentryValues: GlobalWithSentryValues = GLOBAL_OBJ;
+  const kitTracingConfig = globalWithSentryValues.__sentry_sveltekit_tracing_config;
+
+  return {
+    instrumentation: kitTracingConfig?.instrumentation?.server ?? false,
+    tracing: kitTracingConfig?.tracing?.server ?? false,
+  };
+}

packages/sveltekit/src/server/sdk.ts

@@ -1,20 +1,35 @@
 import { applySdkMetadata } from '@sentry/core';
 import type { NodeClient, NodeOptions } from '@sentry/node';
-import { getDefaultIntegrations as getDefaultNodeIntegrations, init as initNodeSdk } from '@sentry/node';
+import {
+  getDefaultIntegrations as getDefaultNodeIntegrations,
+  httpIntegration,
+  init as initNodeSdk,
+} from '@sentry/node';
 import { svelteKitSpansIntegration } from '../server-common/processKitSpans';
 import { rewriteFramesIntegration } from '../server-common/rewriteFramesIntegration';
+import { getKitTracingConfig } from '../server-common/utils';
 
 /**
  * Initialize the Server-side Sentry SDK
  * @param options
  */
 export function init(options: NodeOptions): NodeClient | undefined {
+  const defaultIntegrations = [...getDefaultNodeIntegrations(options), rewriteFramesIntegration()];
+
+  const config = getKitTracingConfig();
+  if (config.instrumentation) {
+    // Whenever `instrumentation` is enabled, we don't need httpIntegration to emit spans
+    // - if `tracing` is enabled, kit will emit the root span
+    // - if `tracing` is disabled, our handler will emit the root span
+    defaultIntegrations.push(httpIntegration({ disableIncomingRequestSpans: true }));
+    if (config.tracing) {
+      // If `tracing` is enabled, we need to instrument spans for the server
+      defaultIntegrations.push(svelteKitSpansIntegration());
+    }
+  }
+
   const opts = {
-    defaultIntegrations: [
-      ...getDefaultNodeIntegrations(options),
-      rewriteFramesIntegration(),
-      svelteKitSpansIntegration(),
-    ],
+    defaultIntegrations,
     ...options,
   };
 

packages/sveltekit/src/vite/injectGlobalValues.ts

@@ -1,7 +1,9 @@
 import type { InternalGlobal } from '@sentry/core';
+import type { SvelteKitTracingConfig } from './svelteConfig';
 
 export type GlobalSentryValues = {
   __sentry_sveltekit_output_dir?: string;
+  __sentry_sveltekit_tracing_config?: SvelteKitTracingConfig;
 };
 
 /**

packages/sveltekit/src/vite/sourceMaps.ts

@@ -11,7 +11,7 @@ import type { Plugin, UserConfig } from 'vite';
 import { WRAPPED_MODULE_SUFFIX } from '../common/utils';
 import type { GlobalSentryValues } from './injectGlobalValues';
 import { getGlobalValueInjectionCode, VIRTUAL_GLOBAL_VALUES_FILE } from './injectGlobalValues';
-import { getAdapterOutputDir, getHooksFileName, loadSvelteConfig } from './svelteConfig';
+import { getAdapterOutputDir, getHooksFileName, getTracingConfig, loadSvelteConfig } from './svelteConfig';
 import type { CustomSentryVitePluginOptions } from './types';
 
 // sorcery has no types, so these are some basic type definitions:
@@ -153,8 +153,11 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
 
   const globalSentryValues: GlobalSentryValues = {
     __sentry_sveltekit_output_dir: adapterOutputDir,
+    __sentry_sveltekit_tracing_config: getTracingConfig(svelteConfig),
   };
 
+  console.log('xx globalSentryValues', globalSentryValues);
+
   const sourceMapSettingsPlugin: Plugin = {
     name: 'sentry-sveltekit-update-source-map-setting-plugin',
     apply: 'build', // only apply this plugin at build time
@@ -235,8 +238,10 @@ export async function makeCustomSentryVitePlugins(options?: CustomSentryVitePlug
     transform: async (code, id) => {
       // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- not end user input + escaped anyway
       const isServerHooksFile = new RegExp(`/${escapeStringForRegex(serverHooksFile)}(.(js|ts|mjs|mts))?`).test(id);
+      const isInstrumentationServerFile = /instrumentation\.server\./.test(id);
 
-      if (isServerHooksFile) {
+      if (isServerHooksFile || isInstrumentationServerFile) {
+        console.log('xx inject global values', id);
         const ms = new MagicString(code);
         ms.append(`\n; import "${VIRTUAL_GLOBAL_VALUES_FILE}";\n`);
         return {

packages/sveltekit/src/vite/svelteConfig.ts

@@ -4,12 +4,31 @@ import * as path from 'path';
 import * as url from 'url';
 import type { SupportedSvelteKitAdapters } from './detectAdapter';
 
+export type SvelteKitTracingConfig = {
+  tracing?: {
+    server: boolean;
+  };
+  instrumentation?: {
+    server: boolean;
+  };
+};
+
+/**
+ * Experimental tracing and instrumentation config is available
+ * @since 2.31.0
+ */
+type BackwardsForwardsCompatibleKitConfig = Config['kit'] & { experimental?: SvelteKitTracingConfig };
+
+interface BackwardsForwardsCompatibleSvelteConfig extends Config {
+  kit?: BackwardsForwardsCompatibleKitConfig;
+}
+
 /**
  * Imports the svelte.config.js file and returns the config object.
  * The sveltekit plugins import the config in the same way.
  * See: https://github.com/sveltejs/kit/blob/master/packages/kit/src/core/config/index.js#L63
  */
-export async function loadSvelteConfig(): Promise<Config> {
+export async function loadSvelteConfig(): Promise<BackwardsForwardsCompatibleSvelteConfig> {
   // This can only be .js (see https://github.com/sveltejs/kit/pull/4031#issuecomment-1049475388)
   const SVELTE_CONFIG_FILE = 'svelte.config.js';
 
@@ -23,7 +42,7 @@ export async function loadSvelteConfig(): Promise<Config> {
     const svelteConfigModule = await import(`${url.pathToFileURL(configFile).href}`);
 
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    return (svelteConfigModule?.default as Config) || {};
+    return (svelteConfigModule?.default as BackwardsForwardsCompatibleSvelteConfig) || {};
   } catch (e) {
     // eslint-disable-next-line no-console
     console.warn("[Source Maps Plugin] Couldn't load svelte.config.js:");
@@ -110,3 +129,21 @@ async function getNodeAdapterOutputDir(svelteConfig: Config): Promise<string> {
 
   return outputDir;
 }
+
+/**
+ * Returns the Sveltekit tracing config users can enable in svelte.config.js.
+ * Available in Kit @since 2.31.0
+ */
+export function getTracingConfig(
+  svelteConfig: BackwardsForwardsCompatibleSvelteConfig,
+): BackwardsForwardsCompatibleKitConfig['experimental'] {
+  const experimentalConfig = svelteConfig.kit?.experimental;
+  return {
+    instrumentation: {
+      server: experimentalConfig?.instrumentation?.server ?? false,
+    },
+    tracing: {
+      server: experimentalConfig?.tracing?.server ?? false,
+    },
+  };
+}