Skip to content

The only tool you need to know what is happening and how to fix it.

started otel examples for actual node/next/hono/nest testing

dduxfb07ab7fdfa1
diff --git a/docs/pages/client/hono/index.mdx b/docs/pages/client/hono/index.mdx
index 4af2f775..87cbe3e1 100644
--- a/docs/pages/client/hono/index.mdx
+++ b/docs/pages/client/hono/index.mdx
@@ -22,10 +22,13 @@ import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+import { Resource } from "@opentelemetry/resources";
const sdk = new NodeSDK({
- serviceName: "my-hono-app",
- serviceVersion: "1.0.0",
+ resource: new Resource({
+ "service.name": "my-hono-app",
+ "service.version": "1.0.0",
+ }),
traceExporter: new OTLPTraceExporter({
url: "https://your-traceway-instance.com/api/otel/v1/traces",
diff --git a/docs/pages/client/nestjs/index.mdx b/docs/pages/client/nestjs/index.mdx
index ed28bd32..7285b0bf 100644
--- a/docs/pages/client/nestjs/index.mdx
+++ b/docs/pages/client/nestjs/index.mdx
@@ -21,10 +21,13 @@ import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+import { Resource } from "@opentelemetry/resources";
const sdk = new NodeSDK({
- serviceName: "my-nestjs-app",
- serviceVersion: "1.0.0",
+ resource: new Resource({
+ "service.name": "my-nestjs-app",
+ "service.version": "1.0.0",
+ }),
traceExporter: new OTLPTraceExporter({
url: "https://your-traceway-instance.com/api/otel/v1/traces",
diff --git a/docs/pages/client/nextjs/index.mdx b/docs/pages/client/nextjs/index.mdx
index a0ce5bbe..d1e01098 100644
--- a/docs/pages/client/nextjs/index.mdx
+++ b/docs/pages/client/nextjs/index.mdx
@@ -33,9 +33,13 @@ export async function register() {
"@opentelemetry/auto-instrumentations-node"
);
+ const { Resource } = await import("@opentelemetry/resources");
+
const sdk = new NodeSDK({
- serviceName: "my-nextjs-app",
- serviceVersion: "1.0.0",
+ resource: new Resource({
+ "service.name": "my-nextjs-app",
+ "service.version": "1.0.0",
+ }),
traceExporter: new OTLPTraceExporter({
url: "https://your-traceway-instance.com/api/otel/v1/traces",
diff --git a/docs/pages/client/node-sdk/index.mdx b/docs/pages/client/node-sdk/index.mdx
index f82ce24c..47e68e51 100644
--- a/docs/pages/client/node-sdk/index.mdx
+++ b/docs/pages/client/node-sdk/index.mdx
@@ -21,10 +21,13 @@ import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+import { Resource } from "@opentelemetry/resources";
const sdk = new NodeSDK({
- serviceName: "my-service",
- serviceVersion: "1.0.0",
+ resource: new Resource({
+ "service.name": "my-service",
+ "service.version": "1.0.0",
+ }),
traceExporter: new OTLPTraceExporter({
url: "https://your-traceway-instance.com/api/otel/v1/traces",
diff --git a/docs/pages/client/otel/traces.mdx b/docs/pages/client/otel/traces.mdx
index fae3d1d4..cee2fed2 100644
--- a/docs/pages/client/otel/traces.mdx
+++ b/docs/pages/client/otel/traces.mdx
@@ -56,10 +56,13 @@ Exceptions are grouped by a normalized hash of the stack trace, so the same logi
import { NodeSDK } from "@opentelemetry/sdk-node";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+import { Resource } from "@opentelemetry/resources";
const sdk = new NodeSDK({
- serviceName: "my-service",
- serviceVersion: "1.0.0",
+ resource: new Resource({
+ "service.name": "my-service",
+ "service.version": "1.0.0",
+ }),
traceExporter: new OTLPTraceExporter({
url: "https://your-traceway-instance.com/api/otel/v1/traces",
headers: {
diff --git a/examples/express-otel/.env.example b/examples/express-otel/.env.example
new file mode 100644
index 00000000..7d636402
--- /dev/null
+++ b/examples/express-otel/.env.example
@@ -0,0 +1,2 @@
+TRACEWAY_URL=http://localhost:8082
+TRACEWAY_TOKEN=your-project-token
diff --git a/examples/express-otel/instrumentation.js b/examples/express-otel/instrumentation.js
new file mode 100644
index 00000000..c91bd33e
--- /dev/null
+++ b/examples/express-otel/instrumentation.js
@@ -0,0 +1,30 @@
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
+import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+
+const tracewayUrl = process.env.TRACEWAY_URL || "http://localhost:8082";
+const tracewayToken = process.env.TRACEWAY_TOKEN || "";
+
+const sdk = new NodeSDK({
+ serviceName: "express-otel-example",
+ serviceVersion: "1.0.0",
+
+ traceExporter: new OTLPTraceExporter({
+ url: `${tracewayUrl}/api/otel/v1/traces`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+
+ metricReader: new PeriodicExportingMetricReader({
+ exporter: new OTLPMetricExporter({
+ url: `${tracewayUrl}/api/otel/v1/metrics`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+ exportIntervalMillis: 10_000,
+ }),
+
+ instrumentations: [getNodeAutoInstrumentations()],
+});
+
+sdk.start();
diff --git a/examples/express-otel/package.json b/examples/express-otel/package.json
new file mode 100644
index 00000000..8e55ff21
--- /dev/null
+++ b/examples/express-otel/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "express-otel-example",
+ "version": "1.0.0",
+ "type": "module",
+ "scripts": {
+ "start": "node --import ./instrumentation.js server.js"
+ },
+ "dependencies": {
+ "express": "^4.21.0",
+ "@opentelemetry/api": "^1.9.0",
+ "@opentelemetry/sdk-node": "^0.57.0",
+ "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+ "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
+ "@opentelemetry/sdk-metrics": "^1.30.0"
+ }
+}
diff --git a/examples/express-otel/server.js b/examples/express-otel/server.js
new file mode 100644
index 00000000..2449ca52
--- /dev/null
+++ b/examples/express-otel/server.js
@@ -0,0 +1,41 @@
+import express from "express";
+
+const app = express();
+app.use(express.json());
+
+const users = [
+ { id: "1", name: "Alice", email: "[email protected]" },
+ { id: "2", name: "Bob", email: "[email protected]" },
+ { id: "3", name: "Charlie", email: "[email protected]" },
+];
+
+app.get("/api/users", (req, res) => {
+ res.json(users);
+});
+
+app.get("/api/users/:id", (req, res) => {
+ const user = users.find((u) => u.id === req.params.id);
+ if (!user) {
+ return res.status(404).json({ error: "User not found" });
+ }
+ res.json(user);
+});
+
+app.post("/api/users", (req, res) => {
+ const newUser = { id: String(users.length + 1), ...req.body };
+ users.push(newUser);
+ res.status(201).json(newUser);
+});
+
+app.get("/api/slow", async (req, res) => {
+ await new Promise((resolve) => setTimeout(resolve, 300));
+ res.json({ message: "Slow response" });
+});
+
+app.get("/api/test-error", () => {
+ throw new Error("Test error from Traceway integration");
+});
+
+app.listen(3001, () => {
+ console.log("Express listening on http://localhost:3001");
+});
diff --git a/examples/hono-otel/.env.example b/examples/hono-otel/.env.example
new file mode 100644
index 00000000..7d636402
--- /dev/null
+++ b/examples/hono-otel/.env.example
@@ -0,0 +1,2 @@
+TRACEWAY_URL=http://localhost:8082
+TRACEWAY_TOKEN=your-project-token
diff --git a/examples/hono-otel/instrumentation.js b/examples/hono-otel/instrumentation.js
new file mode 100644
index 00000000..b85e8bb1
--- /dev/null
+++ b/examples/hono-otel/instrumentation.js
@@ -0,0 +1,30 @@
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
+import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+
+const tracewayUrl = process.env.TRACEWAY_URL || "http://localhost:8082";
+const tracewayToken = process.env.TRACEWAY_TOKEN || "";
+
+const sdk = new NodeSDK({
+ serviceName: "hono-otel-example",
+ serviceVersion: "1.0.0",
+
+ traceExporter: new OTLPTraceExporter({
+ url: `${tracewayUrl}/api/otel/v1/traces`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+
+ metricReader: new PeriodicExportingMetricReader({
+ exporter: new OTLPMetricExporter({
+ url: `${tracewayUrl}/api/otel/v1/metrics`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+ exportIntervalMillis: 10_000,
+ }),
+
+ instrumentations: [getNodeAutoInstrumentations()],
+});
+
+sdk.start();
diff --git a/examples/hono-otel/package.json b/examples/hono-otel/package.json
new file mode 100644
index 00000000..6bc3cdfb
--- /dev/null
+++ b/examples/hono-otel/package.json
@@ -0,0 +1,18 @@
+{
+ "name": "hono-otel-example",
+ "version": "1.0.0",
+ "type": "module",
+ "scripts": {
+ "start": "node --import ./instrumentation.js server.js"
+ },
+ "dependencies": {
+ "hono": "^4.7.0",
+ "@hono/node-server": "^1.14.0",
+ "@opentelemetry/api": "^1.9.0",
+ "@opentelemetry/sdk-node": "^0.57.0",
+ "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+ "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
+ "@opentelemetry/sdk-metrics": "^1.30.0"
+ }
+}
diff --git a/examples/hono-otel/server.js b/examples/hono-otel/server.js
new file mode 100644
index 00000000..4190f6d7
--- /dev/null
+++ b/examples/hono-otel/server.js
@@ -0,0 +1,63 @@
+import { serve } from "@hono/node-server";
+import { Hono } from "hono";
+import { trace, SpanStatusCode } from "@opentelemetry/api";
+
+const app = new Hono();
+
+// Route middleware — sets http.route for endpoint grouping
+app.use("*", async (c, next) => {
+ await next();
+ const span = trace.getActiveSpan();
+ if (span) {
+ span.setAttribute("http.route", c.req.routePath);
+ }
+});
+
+// Error handler — records exceptions as Issues
+app.onError((err, c) => {
+ const span = trace.getActiveSpan();
+ if (span) {
+ span.recordException(err);
+ span.setStatus({ code: SpanStatusCode.ERROR, message: err.message });
+ }
+ return c.json({ error: "Internal Server Error" }, 500);
+});
+
+const users = [
+ { id: "1", name: "Alice", email: "[email protected]" },
+ { id: "2", name: "Bob", email: "[email protected]" },
+ { id: "3", name: "Charlie", email: "[email protected]" },
+];
+
+app.get("/api/users", (c) => {
+ return c.json(users);
+});
+
+app.get("/api/users/:id", (c) => {
+ const id = c.req.param("id");
+ const user = users.find((u) => u.id === id);
+ if (!user) {
+ return c.json({ error: "User not found" }, 404);
+ }
+ return c.json(user);
+});
+
+app.post("/api/users", async (c) => {
+ const body = await c.req.json();
+ const newUser = { id: String(users.length + 1), ...body };
+ users.push(newUser);
+ return c.json(newUser, 201);
+});
+
+app.get("/api/slow", async (c) => {
+ await new Promise((resolve) => setTimeout(resolve, 300));
+ return c.json({ message: "Slow response" });
+});
+
+app.get("/api/test-error", () => {
+ throw new Error("Test error from Hono");
+});
+
+serve({ fetch: app.fetch, port: 3002 }, () => {
+ console.log("Hono listening on http://localhost:3002");
+});
diff --git a/examples/nestjs-otel/.env.example b/examples/nestjs-otel/.env.example
new file mode 100644
index 00000000..7d636402
--- /dev/null
+++ b/examples/nestjs-otel/.env.example
@@ -0,0 +1,2 @@
+TRACEWAY_URL=http://localhost:8082
+TRACEWAY_TOKEN=your-project-token
diff --git a/examples/nestjs-otel/instrumentation.ts b/examples/nestjs-otel/instrumentation.ts
new file mode 100644
index 00000000..a89f1569
--- /dev/null
+++ b/examples/nestjs-otel/instrumentation.ts
@@ -0,0 +1,33 @@
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
+import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
+import { Resource } from "@opentelemetry/resources";
+
+const tracewayUrl = process.env.TRACEWAY_URL || "http://localhost:8082";
+const tracewayToken = process.env.TRACEWAY_TOKEN || "";
+
+const sdk = new NodeSDK({
+ resource: new Resource({
+ "service.name": "nestjs-otel-example",
+ "service.version": "1.0.0",
+ }),
+
+ traceExporter: new OTLPTraceExporter({
+ url: `${tracewayUrl}/api/otel/v1/traces`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+
+ metricReader: new PeriodicExportingMetricReader({
+ exporter: new OTLPMetricExporter({
+ url: `${tracewayUrl}/api/otel/v1/metrics`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+ exportIntervalMillis: 10_000,
+ }),
+
+ instrumentations: [getNodeAutoInstrumentations()],
+});
+
+sdk.start();
diff --git a/examples/nestjs-otel/package.json b/examples/nestjs-otel/package.json
new file mode 100644
index 00000000..8c844518
--- /dev/null
+++ b/examples/nestjs-otel/package.json
@@ -0,0 +1,27 @@
+{
+ "name": "nestjs-otel-example",
+ "version": "1.0.0",
+ "scripts": {
+ "build": "tsc",
+ "start": "node --require ./instrumentation.js dist/main.js",
+ "start:dev": "node --require ts-node/register --require ./instrumentation.ts src/main.ts"
+ },
+ "dependencies": {
+ "@nestjs/common": "^10.4.0",
+ "@nestjs/core": "^10.4.0",
+ "@nestjs/platform-express": "^10.4.0",
+ "reflect-metadata": "^0.2.2",
+ "rxjs": "^7.8.1",
+ "@opentelemetry/api": "^1.9.0",
+ "@opentelemetry/sdk-node": "^0.57.0",
+ "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+ "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
+ "@opentelemetry/sdk-metrics": "^1.30.0"
+ },
+ "devDependencies": {
+ "typescript": "^5.7.0",
+ "ts-node": "^10.9.0",
+ "@types/node": "^22.0.0"
+ }
+}
diff --git a/examples/nestjs-otel/src/app.controller.ts b/examples/nestjs-otel/src/app.controller.ts
new file mode 100644
index 00000000..ec883e52
--- /dev/null
+++ b/examples/nestjs-otel/src/app.controller.ts
@@ -0,0 +1,42 @@
+import { Controller, Get, Post, Param, Body } from "@nestjs/common";
+
+const users = [
+ { id: "1", name: "Alice", email: "[email protected]" },
+ { id: "2", name: "Bob", email: "[email protected]" },
+ { id: "3", name: "Charlie", email: "[email protected]" },
+];
+
+@Controller("api")
+export class AppController {
+ @Get("users")
+ getUsers() {
+ return users;
+ }
+
+ @Get("users/:id")
+ getUser(@Param("id") id: string) {
+ const user = users.find((u) => u.id === id);
+ if (!user) {
+ return { error: "User not found" };
+ }
+ return user;
+ }
+
+ @Post("users")
+ createUser(@Body() body: { name: string; email: string }) {
+ const newUser = { id: String(users.length + 1), ...body };
+ users.push(newUser);
+ return newUser;
+ }
+
+ @Get("slow")
+ async slow() {
+ await new Promise((resolve) => setTimeout(resolve, 300));
+ return { message: "Slow response" };
+ }
+
+ @Get("test-error")
+ testError() {
+ throw new Error("Test error from NestJS");
+ }
+}
diff --git a/examples/nestjs-otel/src/app.module.ts b/examples/nestjs-otel/src/app.module.ts
new file mode 100644
index 00000000..16e67c79
--- /dev/null
+++ b/examples/nestjs-otel/src/app.module.ts
@@ -0,0 +1,7 @@
+import { Module } from "@nestjs/common";
+import { AppController } from "./app.controller";
+
+@Module({
+ controllers: [AppController],
+})
+export class AppModule {}
diff --git a/examples/nestjs-otel/src/main.ts b/examples/nestjs-otel/src/main.ts
new file mode 100644
index 00000000..ab0d2543
--- /dev/null
+++ b/examples/nestjs-otel/src/main.ts
@@ -0,0 +1,10 @@
+import "reflect-metadata";
+import { NestFactory } from "@nestjs/core";
+import { AppModule } from "./app.module";
+
+async function bootstrap() {
+ const app = await NestFactory.create(AppModule);
+ await app.listen(3003);
+ console.log("NestJS listening on http://localhost:3003");
+}
+bootstrap();
diff --git a/examples/nestjs-otel/tsconfig.json b/examples/nestjs-otel/tsconfig.json
new file mode 100644
index 00000000..479d4d66
--- /dev/null
+++ b/examples/nestjs-otel/tsconfig.json
@@ -0,0 +1,14 @@
+{
+ "compilerOptions": {
+ "module": "commonjs",
+ "target": "ES2021",
+ "experimentalDecorators": true,
+ "emitDecoratorMetadata": true,
+ "outDir": "./dist",
+ "rootDir": "./src",
+ "strict": false,
+ "esModuleInterop": true,
+ "skipLibCheck": true
+ },
+ "include": ["src/**/*"]
+}
diff --git a/examples/nextjs-otel/.env.example b/examples/nextjs-otel/.env.example
new file mode 100644
index 00000000..7d636402
--- /dev/null
+++ b/examples/nextjs-otel/.env.example
@@ -0,0 +1,2 @@
+TRACEWAY_URL=http://localhost:8082
+TRACEWAY_TOKEN=your-project-token
diff --git a/examples/nextjs-otel/app/api/slow/route.ts b/examples/nextjs-otel/app/api/slow/route.ts
new file mode 100644
index 00000000..255a2600
--- /dev/null
+++ b/examples/nextjs-otel/app/api/slow/route.ts
@@ -0,0 +1,6 @@
+import { withRoute } from "@/lib/with-route";
+
+export const GET = withRoute("/api/slow", async () => {
+ await new Promise((resolve) => setTimeout(resolve, 300));
+ return Response.json({ message: "Slow response" });
+});
diff --git a/examples/nextjs-otel/app/api/test-error/route.ts b/examples/nextjs-otel/app/api/test-error/route.ts
new file mode 100644
index 00000000..cc035d39
--- /dev/null
+++ b/examples/nextjs-otel/app/api/test-error/route.ts
@@ -0,0 +1,5 @@
+import { withRoute } from "@/lib/with-route";
+
+export const GET = withRoute("/api/test-error", async () => {
+ throw new Error("Test error from Next.js");
+});
diff --git a/examples/nextjs-otel/app/api/users/[id]/route.ts b/examples/nextjs-otel/app/api/users/[id]/route.ts
new file mode 100644
index 00000000..00f33995
--- /dev/null
+++ b/examples/nextjs-otel/app/api/users/[id]/route.ts
@@ -0,0 +1,19 @@
+import { withRoute } from "@/lib/with-route";
+
+const users = [
+ { id: "1", name: "Alice", email: "[email protected]" },
+ { id: "2", name: "Bob", email: "[email protected]" },
+ { id: "3", name: "Charlie", email: "[email protected]" },
+];
+
+export const GET = withRoute(
+ "/api/users/[id]",
+ async (req, { params }) => {
+ const { id } = await params;
+ const user = users.find((u) => u.id === id);
+ if (!user) {
+ return Response.json({ error: "User not found" }, { status: 404 });
+ }
+ return Response.json(user);
+ }
+);
diff --git a/examples/nextjs-otel/app/api/users/route.ts b/examples/nextjs-otel/app/api/users/route.ts
new file mode 100644
index 00000000..5f930d8e
--- /dev/null
+++ b/examples/nextjs-otel/app/api/users/route.ts
@@ -0,0 +1,18 @@
+import { withRoute } from "@/lib/with-route";
+
+const users = [
+ { id: "1", name: "Alice", email: "[email protected]" },
+ { id: "2", name: "Bob", email: "[email protected]" },
+ { id: "3", name: "Charlie", email: "[email protected]" },
+];
+
+export const GET = withRoute("/api/users", async () => {
+ return Response.json(users);
+});
+
+export const POST = withRoute("/api/users", async (req) => {
+ const body = await req.json();
+ const newUser = { id: String(users.length + 1), ...body };
+ users.push(newUser);
+ return Response.json(newUser, { status: 201 });
+});
diff --git a/examples/nextjs-otel/app/layout.tsx b/examples/nextjs-otel/app/layout.tsx
new file mode 100644
index 00000000..225b6038
--- /dev/null
+++ b/examples/nextjs-otel/app/layout.tsx
@@ -0,0 +1,11 @@
+export default function RootLayout({
+ children,
+}: {
+ children: React.ReactNode;
+}) {
+ return (
+ <html lang="en">
+ <body>{children}</body>
+ </html>
+ );
+}
diff --git a/examples/nextjs-otel/app/page.tsx b/examples/nextjs-otel/app/page.tsx
new file mode 100644
index 00000000..36ed3f56
--- /dev/null
+++ b/examples/nextjs-otel/app/page.tsx
@@ -0,0 +1,25 @@
+export default function Home() {
+ return (
+ <div style={{ padding: "2rem", fontFamily: "monospace" }}>
+ <h1>Next.js OTel Example</h1>
+ <p>Test endpoints:</p>
+ <ul>
+ <li>
+ <a href="/api/users">GET /api/users</a>
+ </li>
+ <li>
+ <a href="/api/users/1">GET /api/users/1</a>
+ </li>
+ <li>
+ <a href="/api/users/2">GET /api/users/2</a>
+ </li>
+ <li>
+ <a href="/api/slow">GET /api/slow</a>
+ </li>
+ <li>
+ <a href="/api/test-error">GET /api/test-error</a>
+ </li>
+ </ul>
+ </div>
+ );
+}
diff --git a/examples/nextjs-otel/instrumentation.ts b/examples/nextjs-otel/instrumentation.ts
new file mode 100644
index 00000000..b0806d39
--- /dev/null
+++ b/examples/nextjs-otel/instrumentation.ts
@@ -0,0 +1,46 @@
+export async function register() {
+ if (process.env.NEXT_RUNTIME === "nodejs") {
+ const { NodeSDK } = await import("@opentelemetry/sdk-node");
+ const { OTLPTraceExporter } = await import(
+ "@opentelemetry/exporter-trace-otlp-http"
+ );
+ const { OTLPMetricExporter } = await import(
+ "@opentelemetry/exporter-metrics-otlp-http"
+ );
+ const { PeriodicExportingMetricReader } = await import(
+ "@opentelemetry/sdk-metrics"
+ );
+ const { getNodeAutoInstrumentations } = await import(
+ "@opentelemetry/auto-instrumentations-node"
+ );
+
+ const tracewayUrl = process.env.TRACEWAY_URL || "http://localhost:8082";
+ const tracewayToken = process.env.TRACEWAY_TOKEN || "";
+
+ const { Resource } = await import("@opentelemetry/resources");
+
+ const sdk = new NodeSDK({
+ resource: new Resource({
+ "service.name": "nextjs-otel-example",
+ "service.version": "1.0.0",
+ }),
+
+ traceExporter: new OTLPTraceExporter({
+ url: `${tracewayUrl}/api/otel/v1/traces`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+
+ metricReader: new PeriodicExportingMetricReader({
+ exporter: new OTLPMetricExporter({
+ url: `${tracewayUrl}/api/otel/v1/metrics`,
+ headers: { Authorization: `Bearer ${tracewayToken}` },
+ }),
+ exportIntervalMillis: 10_000,
+ }),
+
+ instrumentations: [getNodeAutoInstrumentations()],
+ });
+
+ sdk.start();
+ }
+}
diff --git a/examples/nextjs-otel/lib/with-route.ts b/examples/nextjs-otel/lib/with-route.ts
new file mode 100644
index 00000000..6ba6a990
--- /dev/null
+++ b/examples/nextjs-otel/lib/with-route.ts
@@ -0,0 +1,27 @@
+import { trace, SpanStatusCode } from "@opentelemetry/api";
+
+type RouteHandler = (
+ req: Request,
+ context: { params: Promise<Record<string, string>> }
+) => Response | Promise<Response>;
+
+export function withRoute(route: string, handler: RouteHandler): RouteHandler {
+ return async (req, context) => {
+ const span = trace.getActiveSpan();
+ if (span) {
+ span.setAttribute("http.route", route);
+ }
+ try {
+ return await handler(req, context);
+ } catch (error) {
+ if (span) {
+ span.recordException(error as Error);
+ span.setStatus({
+ code: SpanStatusCode.ERROR,
+ message: (error as Error).message,
+ });
+ }
+ throw error;
+ }
+ };
+}
diff --git a/examples/nextjs-otel/next-env.d.ts b/examples/nextjs-otel/next-env.d.ts
new file mode 100644
index 00000000..830fb594
--- /dev/null
+++ b/examples/nextjs-otel/next-env.d.ts
@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+/// <reference path="./.next/types/routes.d.ts" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
diff --git a/examples/nextjs-otel/next.config.js b/examples/nextjs-otel/next.config.js
new file mode 100644
index 00000000..658404ac
--- /dev/null
+++ b/examples/nextjs-otel/next.config.js
@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+module.exports = nextConfig;
diff --git a/examples/nextjs-otel/package.json b/examples/nextjs-otel/package.json
new file mode 100644
index 00000000..9219d4ce
--- /dev/null
+++ b/examples/nextjs-otel/package.json
@@ -0,0 +1,25 @@
+{
+ "name": "nextjs-otel-example",
+ "version": "1.0.0",
+ "scripts": {
+ "dev": "next dev -p 3004",
+ "build": "next build",
+ "start": "next start -p 3004"
+ },
+ "dependencies": {
+ "next": "^15.2.0",
+ "react": "^19.0.0",
+ "react-dom": "^19.0.0",
+ "@opentelemetry/api": "^1.9.0",
+ "@opentelemetry/sdk-node": "^0.57.0",
+ "@opentelemetry/auto-instrumentations-node": "^0.56.0",
+ "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
+ "@opentelemetry/sdk-metrics": "^1.30.0"
+ },
+ "devDependencies": {
+ "typescript": "^5.7.0",
+ "@types/node": "^22.0.0",
+ "@types/react": "^19.0.0"
+ }
+}
diff --git a/examples/nextjs-otel/tsconfig.json b/examples/nextjs-otel/tsconfig.json
new file mode 100644
index 00000000..5dec2592
--- /dev/null
+++ b/examples/nextjs-otel/tsconfig.json
@@ -0,0 +1,39 @@
+{
+ "compilerOptions": {
+ "target": "ES2017",
+ "lib": [
+ "dom",
+ "dom.iterable",
+ "esnext"
+ ],
+ "allowJs": true,
+ "skipLibCheck": true,
+ "strict": false,
+ "noEmit": true,
+ "esModuleInterop": true,
+ "module": "esnext",
+ "moduleResolution": "bundler",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "jsx": "preserve",
+ "incremental": true,
+ "paths": {
+ "@/*": [
+ "./*"
+ ]
+ },
+ "plugins": [
+ {
+ "name": "next"
+ }
+ ]
+ },
+ "include": [
+ "**/*.ts",
+ "**/*.tsx",
+ ".next/types/**/*.ts"
+ ],
+ "exclude": [
+ "node_modules"
+ ]
+}