Next.js の Standalone Build のサーバーサイドに Datadog APM を導入する

前提

https://zenn.dev/aotolog/articles/nextjs-datadog-apm
上記の記事が調べる時に大変助かりました。この記事は上記の内容をベースにしています。

• Next.js 14.2.5
• サーバーサイドは、Vercel 公式の提供する Dockerfile を利用して、コンテナで動かす
  • https://github.com/vercel/next.js/blob/canary/examples/with-docker/Dockerfile
• next.config.js
  • output: 'standalone'

解決

FROM node:18-alpine AS base

# Install dependencies only when needed
FROM base AS deps
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
RUN apk add --no-cache libc6-compat
WORKDIR /app

# Install dependencies based on the preferred package manager
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
RUN \
  if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
  elif [ -f package-lock.json ]; then npm ci; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm i --frozen-lockfile; \
  else echo "Lockfile not found." && exit 1; \
  fi
+RUN npm install --prefix ddtrace dd-trace --no-save --install-strategy=nested

# Rebuild the source code only when needed
FROM base AS builder
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .

# Next.js collects completely anonymous telemetry data about general usage.
# Learn more here: https://nextjs.org/telemetry
# Uncomment the following line in case you want to disable telemetry during the build.
# ENV NEXT_TELEMETRY_DISABLED=1

RUN \
  if [ -f yarn.lock ]; then yarn run build; \
  elif [ -f package-lock.json ]; then npm run build; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm run build; \
  else echo "Lockfile not found." && exit 1; \
  fi

# Production image, copy all the files and run next
FROM base AS runner
WORKDIR /app

ENV NODE_ENV=production
# Uncomment the following line in case you want to disable telemetry during runtime.
# ENV NEXT_TELEMETRY_DISABLED=1

RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs

COPY --from=builder /app/public ./public

# Set the correct permission for prerender cache
RUN mkdir .next
RUN chown nextjs:nodejs .next

# Automatically leverage output traces to reduce image size
# https://nextjs.org/docs/advanced-features/output-file-tracing
COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static
+COPY --from=deps --chown=nextjs:nodejs /app/ddtrace/node_modules ./node_modules

USER nextjs

EXPOSE 3000

ENV PORT=3000

# server.js is created by next build from the standalone output
# https://nextjs.org/docs/pages/api-reference/next-config-js/output
ENV HOSTNAME="0.0.0.0"
-CMD ["node", "server.js"]
+CMD ["node", "--require", "dd-trace/init", "server.js"]

詳細

Datadog APM をサーバーサイドに導入するためには、Node.js版のパッケージdd-traceを利用するしかなく、引用した記事で書かれているように、

Node.js APM ライブラリであるdd-traceが Next.js のサーバーサイドモジュール群にインポートされる前にロードされる必要があります。

node --requireを利用して、dd-traceをプリロードすることで、これを実現するというところまでは問題ない。

しかし、Next.js の standalone ビルドでは、コンパイルの結果の./.next/standalone/node_modulesには、dd-traceのパッケージが含まれないので、プリロードはモジュールが見つからずに失敗する。これは、Next.jsのコンパイラーが解析を行って、不要と判断されたパッケージを除外するためで、dd-traceがpackage.jsonに含まれていても、アプリケーションのコードから検出できないと、最適化の対象として省かれる。

そこで、dd-traceを別のディレクトリにインストールしておいて、Next.js のビルドの結果のnode_moduleにいれるといいのではないかと考えて、やってみたら、うまくいった。

--install-strategy=nestedを指定するのは、dd-traceの依存パッケージがすべて、hoist されずに、dd-traceのディレクトリの中に入る（参照）ので、Next.js のビルドの結果のnode_moduleと干渉することがなくなるため。