Setup OTEL with Sentry for AvaTax (#1801)

Author: krzysztofzuraw

.changeset/fuzzy-cougars-grin.md

@@ -0,0 +1,5 @@
+---
+"saleor-app-avatax": patch
+---
+
+Setup Sentry integration with our OTEL setup.

apps/avatax/package.json

@@ -47,6 +47,7 @@
     "@saleor/webhook-utils": "workspace:*",
     "@sentry/cli": "catalog:",
     "@sentry/nextjs": "catalog:",
+    "@sentry/opentelemetry": "9.8.0",
     "@t3-oss/env-nextjs": "0.11.1",
     "@trpc/client": "catalog:",
     "@trpc/next": "catalog:",

apps/avatax/src/env.ts

@@ -40,6 +40,7 @@ export const env = createEnv({
     OTEL_ACCESS_TOKEN: z.string().optional(),
     VERCEL_ENV: z.string().optional(),
     REPOSITORY_URL: z.string().optional(),
+    OTEL_TRACES_SAMPLER_ARG: z.coerce.number().min(0).max(1).optional().default(1),
   },
   shared: {
     NODE_ENV: z.enum(["development", "production", "test"]),
@@ -78,6 +79,7 @@ export const env = createEnv({
     OTEL_ACCESS_TOKEN: process.env.OTEL_ACCESS_TOKEN,
     VERCEL_ENV: process.env.VERCEL_ENV,
     REPOSITORY_URL: process.env.REPOSITORY_URL,
+    OTEL_TRACES_SAMPLER_ARG: process.env.OTEL_TRACES_SAMPLER_ARG,
   },
   isServer: typeof window === "undefined" || process.env.NODE_ENV === "test",
 });

apps/avatax/src/instrumentation.ts

@@ -1,14 +1,14 @@
 // Use `process.env` here to avoid broken Next.js build
 
 export async function register() {
-  if (process.env.NEXT_RUNTIME === "nodejs" && process.env.OTEL_ENABLED === "true") {
+  if (
+    process.env.NEXT_RUNTIME === "nodejs" &&
+    process.env.OTEL_ENABLED === "true" &&
+    process.env.NEXT_PUBLIC_SENTRY_DSN
+  ) {
     await import("./instrumentations/otel-node");
   }
 
-  if (process.env.NEXT_RUNTIME === "nodejs" && process.env.NEXT_PUBLIC_SENTRY_DSN) {
-    await import("./instrumentations/sentry-node");
-  }
-
   if (process.env.NEXT_RUNTIME === "edge" && process.env.NEXT_PUBLIC_SENTRY_DSN) {
     await import("./instrumentations/sentry-edge");
   }

apps/avatax/src/instrumentations/otel-node.ts

@@ -1,15 +1,70 @@
+/* eslint-disable max-params */
+import { Context, Link, SpanAttributes, SpanKind } from "@opentelemetry/api";
+import { ParentBasedSampler, TraceIdRatioBasedSampler } from "@opentelemetry/sdk-trace-node";
 import { ATTR_SERVICE_VERSION } from "@opentelemetry/semantic-conventions";
 import { ATTR_DEPLOYMENT_ENVIRONMENT_NAME } from "@opentelemetry/semantic-conventions/incubating";
 import { createAwsInstrumentation } from "@saleor/apps-otel/src/aws-instrumentation-factory";
 import { createBatchSpanProcessor } from "@saleor/apps-otel/src/batch-span-processor-factory";
 import { createHttpInstrumentation } from "@saleor/apps-otel/src/http-instrumentation-factory";
 import { ObservabilityAttributes } from "@saleor/apps-otel/src/observability-attributes";
+import * as Sentry from "@sentry/nextjs";
+import { SentryPropagator, wrapSamplingDecision } from "@sentry/opentelemetry";
 import { registerOTel } from "@vercel/otel";
 
 import { env } from "@/env";
+import { createLogger } from "@/logger";
 
 import pkg from "../../package.json";
 
+const logger = createLogger("instrumentations/otel-node");
+
+// Use ParentBasedSampler to make decision and then wrap it with Sentry wrapSamplingDecision
+class AppSampler extends ParentBasedSampler {
+  shouldSample(
+    context: Context,
+    traceId: string,
+    spanName: string,
+    spanKind: SpanKind,
+    attributes: SpanAttributes,
+    links: Link[],
+  ) {
+    const { decision } = super.shouldSample(
+      context,
+      traceId,
+      spanName,
+      spanKind,
+      attributes,
+      links,
+    );
+
+    logger.info("AppSampler.shouldSample.decision", { decision });
+
+    return wrapSamplingDecision({
+      decision,
+      context,
+      spanAttributes: attributes,
+    });
+  }
+  toString() {
+    return "AppSampler";
+  }
+}
+
+Sentry.init({
+  dsn: env.NEXT_PUBLIC_SENTRY_DSN,
+  environment: env.ENV,
+  includeLocalVariables: true,
+  skipOpenTelemetrySetup: true,
+  registerEsmLoaderHooks: false,
+  integrations: [
+    Sentry.localVariablesIntegration({
+      captureAllExceptions: true,
+    }),
+    Sentry.extraErrorDataIntegration(),
+    Sentry.httpIntegration({ spans: false }),
+  ],
+});
+
 registerOTel({
   serviceName: env.OTEL_SERVICE_NAME,
   attributes: {
@@ -27,4 +82,9 @@ registerOTel({
     }),
   ],
   instrumentations: [createAwsInstrumentation(), createHttpInstrumentation()],
+  traceSampler: new AppSampler({
+    root: new TraceIdRatioBasedSampler(env.OTEL_TRACES_SAMPLER_ARG),
+  }),
+  propagators: [new SentryPropagator()],
+  contextManager: new Sentry.SentryContextManager(),
 });