SolidStart v2 + OpenTelemetry

[peterhirn]

Hi,

I just want to share my minimal v2 OpenTelemetry example, based on the basic template. Please let me know if this can be improved.

package.json

{
  "name": "solid-start-v2-opentelemetry",
  "type": "module",
  "license": "MIT",
  "scripts": {
    "dev": "vite dev",
    "build": "vite build",
    "start": "node --import=./.output/server/_ssr/instrument.mjs .output/server/index.mjs"
  },
  "dependencies": {
    "@opentelemetry/instrumentation-dns": "^0.64.0",
    "@opentelemetry/instrumentation-http": "^0.221.0",
    "@opentelemetry/instrumentation-net": "^0.65.0",
    "@opentelemetry/instrumentation-pino": "^0.67.0",
    "@opentelemetry/instrumentation-runtime-node": "^0.34.0",
    "@opentelemetry/instrumentation-undici": "^0.31.0",
    "@opentelemetry/resources": "^2.10.0",
    "@opentelemetry/sdk-logs": "^0.221.0",
    "@opentelemetry/sdk-metrics": "^2.10.0",
    "@opentelemetry/sdk-node": "^0.221.0",
    "@opentelemetry/sdk-trace-node": "^2.10.0",
    "@solidjs/meta": "^0.29.4",
    "@solidjs/router": "^1.0.0",
    "@solidjs/start": "^2.0.0",
    "import-in-the-middle": "^3.3.3",
    "nitro": "^3.0.260610-beta",
    "solid-js": "^1.9.14",
    "vite": "^8.0.0"
  },
  "devDependencies": {
    "@types/node": "^26.1.2",
    "typescript": "^7.0.2"
  },
  "engines": {
    "node": "26.6.0"
  },
  "packageManager": "pnpm@11.20.0"
}

vite.config.ts

import { solidStart } from "@solidjs/start/config";
import { nitro } from "nitro/vite";
import { type Plugin, type UserConfig, type ConfigEnv, defineConfig } from "vite";

const instrument = (): Plugin => ({
  name: "instrument",
  apply: "build",
  enforce: "pre",
  async config(_config: UserConfig, _env: ConfigEnv): Promise<UserConfig> {
    return {
      appType: "custom",
      environments: {
        instrument: {
          consumer: "server",
          build: {
            ssr: true,
            write: true,
            copyPublicDir: false,
            rolldownOptions: {
              input: "./src/instrument.ts"
            },
            outDir: "dist/server"
          }
        }
      }
    };
  }
});

export default defineConfig({
  plugins: [instrument(), solidStart(), nitro({ plugins: ["./src/shutdown.ts"] })],
  clearScreen: false
});

src/instrument.ts

import { DnsInstrumentation } from "@opentelemetry/instrumentation-dns";
import { HttpInstrumentation } from "@opentelemetry/instrumentation-http";
import { NetInstrumentation } from "@opentelemetry/instrumentation-net";
import { PinoInstrumentation } from "@opentelemetry/instrumentation-pino";
import { RuntimeNodeInstrumentation } from "@opentelemetry/instrumentation-runtime-node";
import { UndiciInstrumentation } from "@opentelemetry/instrumentation-undici";
import { envDetector, hostDetector, processDetector } from "@opentelemetry/resources";
import {
  ConsoleLogRecordExporter,
  SimpleLogRecordProcessor
} from "@opentelemetry/sdk-logs";
import {
  ConsoleMetricExporter,
  PeriodicExportingMetricReader
} from "@opentelemetry/sdk-metrics";
import { NodeSDK } from "@opentelemetry/sdk-node";
import { SimpleSpanProcessor, ConsoleSpanExporter } from "@opentelemetry/sdk-trace-node";
// @ts-expect-error Missing types
import { register } from "import-in-the-middle/register-hooks.mjs";

declare global {
  var telemetrySdk: NodeSDK;
}

register();

globalThis.telemetrySdk = new NodeSDK({
  spanProcessors: [
    //new BatchSpanProcessor(new OTLPTraceExporter())
    new SimpleSpanProcessor(new ConsoleSpanExporter())
  ],
  logRecordProcessors: [
    //new BatchLogRecordProcessor({ exporter: new OTLPLogExporter() })
    new SimpleLogRecordProcessor({ exporter: new ConsoleLogRecordExporter() })
  ],
  metricReaders: [
    //new PeriodicExportingMetricReader({
    //  exporter: new OTLPMetricExporter()
    //})
    new PeriodicExportingMetricReader({
      exporter: new ConsoleMetricExporter(),
      exportIntervalMillis: 30_000
    })
  ],
  autoDetectResources: true,
  resourceDetectors: [envDetector, processDetector, hostDetector],
  instrumentations: [
    new NetInstrumentation(),
    new DnsInstrumentation(),
    new HttpInstrumentation(),
    new UndiciInstrumentation(),
    new PinoInstrumentation(),
    new RuntimeNodeInstrumentation({
      monitoringPrecision: 1_000
    })
  ]
});

console.debug("Starting telemetry");
globalThis.telemetrySdk.start();

src/shutdown.ts

import { definePlugin } from "nitro";
import { setTimeout } from "node:timers/promises";

async function shutdownTelemetry(): Promise<void> {
  if (globalThis.telemetrySdk) {
    try {
      console.debug("Shutdown telemetry");
      await globalThis.telemetrySdk.shutdown();
    } catch (error) {
      console.error(error, "Failed to shutdown telemetry sdk");
    }
  } else {
    console.debug("Telemetry sdk not initialized");
  }
}

async function shutdown(): Promise<void> {
  try {
    console.debug("Shutdown");
    await shutdownTelemetry();

    console.debug("Simulate long shutdown operation...");
    await setTimeout(3_000, "resolved");

    console.info("Shutdown finished");
  } finally {
    // Looks like this is no longer necessary
    //process.exit();
  }
}

export default definePlugin((_nitro) => {
  // see https://github.com/nitrojs/nitro/issues/4015
  //nitro.hooks.hook("close", async () => await shutdown());

  process.once("SIGINT", shutdown);
  process.once("SIGTERM", shutdown);
});

Dockerfile

FROM --platform=$BUILDPLATFORM node:26.6.0-alpine@sha256:a4fb14143ee24c038c851864fe85fd90f9121abc8fdca3092798bcc02e06b1d8 AS restore
WORKDIR /build

COPY package.json .
COPY pnpm-lock.yaml .
COPY pnpm-workspace.yaml .

RUN npm install -g corepack@0.35.0 \
  && echo 'engineStrict: true' >> pnpm-workspace.yaml \
  && pnpm install --frozen-lockfile

FROM --platform=$BUILDPLATFORM restore AS build
COPY vite.config.ts .
COPY tsconfig.json .
COPY src/ src/

RUN pnpm build

FROM node:26.6.0-alpine@sha256:a4fb14143ee24c038c851864fe85fd90f9121abc8fdca3092798bcc02e06b1d8 AS web
COPY --from=build /build/.output app

ENV PORT=3000 \
    NODE_ENV=production \
    NODE_OPTIONS="--trace-warnings --disable-warning=ExperimentalWarning --import=./app/server/_ssr/instrument.mjs" \
    OTEL_SEMCONV_STABILITY_OPT_IN=http

EXPOSE ${PORT}/tcp

USER node
CMD ["app/server/index.mjs"]

podman build . -t web
podman run -it --rm -p 3000:3000 web

TODO

• instrument client
• expose nitro telemetry

❤️

[birkskyum]

Great idea with an otel template - can you open a PR against the https://github.com/solidjs/templates repo in the solid-start-v2 folder

[peterhirn]

I'm currently trying to apply this to a medium sized production app and running into some issue (bundling related I think). I'll fix those, then open a PR 👍