feat(remix): Vendor in opentelemetry-instrumentation-remix (#16145)

Resolves: #15739

- Removed Remix v1-related instrumentation code from the original
implementation while vendoring in.

- Also, FormData entries for manual instrumentation are aligned with
OTEL use.
Resolves: #16140

Author: onurtemizkan

packages/remix/package.json

@@ -65,14 +65,15 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/instrumentation": "^0.57.2",
+    "@opentelemetry/semantic-conventions": "^1.30.0",
     "@remix-run/router": "1.x",
     "@sentry/cli": "^2.43.0",
     "@sentry/core": "9.18.0",
     "@sentry/node": "9.18.0",
     "@sentry/opentelemetry": "9.18.0",
     "@sentry/react": "9.18.0",
     "glob": "^10.3.4",
-    "opentelemetry-instrumentation-remix": "0.8.0",
     "yargs": "^17.6.0"
   },
   "devDependencies": {

packages/remix/src/server/errors.ts

@@ -134,7 +134,7 @@ export async function errorHandleDataFunction(
         const options = getClient()?.getOptions() as RemixOptions | undefined;
 
         if (options?.sendDefaultPii && options.captureActionFormDataKeys) {
-          await storeFormDataKeys(args, span);
+          await storeFormDataKeys(args, span, options.captureActionFormDataKeys);
         }
       }
 

packages/remix/src/server/integrations/opentelemetry.ts

@@ -1,8 +1,8 @@
 import type { Client, IntegrationFn, Span } from '@sentry/core';
 import { defineIntegration, SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
 import { generateInstrumentOnce, getClient, spanToJSON } from '@sentry/node';
-import { RemixInstrumentation } from 'opentelemetry-instrumentation-remix';
 import type { RemixOptions } from '../../utils/remixOptions';
+import { RemixInstrumentation } from '../../vendor/instrumentation';
 
 const INTEGRATION_NAME = 'Remix';
 

packages/remix/src/utils/utils.ts

@@ -10,7 +10,11 @@ type ServerRouteManifest = ServerBuild['routes'];
 /**
  *
  */
-export async function storeFormDataKeys(args: LoaderFunctionArgs | ActionFunctionArgs, span: Span): Promise<void> {
+export async function storeFormDataKeys(
+  args: LoaderFunctionArgs | ActionFunctionArgs,
+  span: Span,
+  formDataKeys?: Record<string, string | boolean> | undefined,
+): Promise<void> {
   try {
     // We clone the request for Remix be able to read the FormData later.
     const clonedRequest = args.request.clone();
@@ -21,7 +25,18 @@ export async function storeFormDataKeys(args: LoaderFunctionArgs | ActionFunctio
     const formData = await clonedRequest.formData();
 
     formData.forEach((value, key) => {
-      span.setAttribute(`remix.action_form_data.${key}`, typeof value === 'string' ? value : '[non-string value]');
+      let attrKey = key;
+
+      if (formDataKeys?.[key]) {
+        if (typeof formDataKeys[key] === 'string') {
+          attrKey = formDataKeys[key] as string;
+        }
+
+        span.setAttribute(
+          `remix.action_form_data.${attrKey}`,
+          typeof value === 'string' ? value : '[non-string value]',
+        );
+      }
     });
   } catch (e) {
     DEBUG_BUILD && logger.warn('Failed to read FormData from request', e);