trpc-monitoring-middleware 0.0.1

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2026 Alexis Tacnet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,96 @@
+# tRPC monitoring middleware
+
+A simple tRPC middleware for monitoring and logging procedures.
+
+## Features
+
+- OpenTelemetry integration for metrics and traces
+- Requests logging
+
+## Installation
+
+```bash
+npm install trpc-monitoring-middleware
+```
+
+## Usage
+
+```typescript
+import { initTRPC } from "@trpc/server";
+import { createMonitoringMiddleware } from "trpc-monitoring-middleware";
+
+const t = initTRPC.create();
+
+const monitoringMiddleware = createMonitoringMiddleware();
+
+export const publicProcedure = procedure.concat(monitoringMiddleware);
+```
+
+## OpenTelemetry Integration
+
+The middleware automatically exports the following metrics:
+
+- `trpc.procedures`: Counter for the total number of tRPC procedure calls
+- `trpc.time`: Histogram for the duration of tRPC procedure execution in milliseconds
+
+These metrics are labeled with:
+
+- `path`: The tRPC procedure path
+- `type`: The procedure type (query/mutation/subscription)
+- `ok`: Boolean indicating success/failure
+- `error_code`: Error code for failed procedures
+
+The middleware also creates OpenTelemetry traces for each procedure call with:
+
+- Span name: `trpc/${path} (${type})`
+- Attributes: path, type, ok status, and error details
+
+## Logging Integration
+
+The middleware provides structured logging through a compatible logger interface. It is recommended to use [Pino](https://github.com/pinojs/pino) or [Winston](https://github.com/winstonjs/winston) as a logger.
+
+- **Procedure-specific logging**: Each procedure gets a child logger with procedure context
+- **Error logging**: Internal errors and unexpected errors are logged with full error details
+- **Error classification**: Internal server errors are automatically detected and logged separately
+
+Error codes classified as internal errors:
+
+- `INTERNAL_SERVER_ERROR`
+- `NOT_IMPLEMENTED`
+- `BAD_GATEWAY`
+- `SERVICE_UNAVAILABLE`
+- `GATEWAY_TIMEOUT`
+
+## Configuration
+
+```typescript
+import { createMonitoringMiddleware } from "trpc-monitoring-middleware";
+
+const monitoringMiddleware = createMonitoringMiddleware({
+  onInternalError: (error: Error) => {
+    // Custom error handling
+    console.error("Internal error:", error);
+  },
+  logger: {
+    error: (errorData, message) => {
+      // Custom error logging
+      console.error(message, errorData);
+    },
+    child: (data) => {
+      // Return a new logger instance with additional context
+      return {
+        error: (errorData, message) => {
+          console.error(message, { ...data, ...errorData });
+        },
+        child: (additionalData) => {
+          return this.child({ ...data, ...additionalData });
+        },
+      };
+    },
+  },
+});
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+import * as _trpc_server0 from "@trpc/server";
+
+//#region src/index.d.ts
+interface MonitoringMiddlewareCompatibleLogger {
+  error: (error: Record<string, unknown>, message: string) => void;
+  child: (data: Record<string, unknown>) => MonitoringMiddlewareCompatibleLogger;
+}
+interface MonitoringMiddlewareOptions {
+  onInternalError?: (error: Error) => void;
+  logger?: MonitoringMiddlewareCompatibleLogger;
+}
+/**
+ * Creates a middleware for monitoring tRPC procedures using OpenTelemetry.
+ *
+ * @param pluginOpts - Optional configuration for the middleware.
+ */
+declare function createMonitoringMiddleware(pluginOpts?: MonitoringMiddlewareOptions): _trpc_server0.TRPCProcedureBuilder<object, object, {
+  logger: MonitoringMiddlewareCompatibleLogger | undefined;
+}, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, _trpc_server0.TRPCUnsetMarker, false>;
+//#endregion
+export { createMonitoringMiddleware };

package/dist/index.mjs

@@ -0,0 +1,86 @@
+import { metrics, trace } from "@opentelemetry/api";
+import { initTRPC } from "@trpc/server";
+
+//#region src/index.ts
+const INTERNAL_ERRORS = new Set([
+	"INTERNAL_SERVER_ERROR",
+	"NOT_IMPLEMENTED",
+	"BAD_GATEWAY",
+	"SERVICE_UNAVAILABLE",
+	"GATEWAY_TIMEOUT"
+]);
+const tracer = trace.getTracer("trpc");
+const meter = metrics.getMeter("trpc");
+const trpcProcedures = meter.createCounter("trpc.procedures");
+const trpcTime = meter.createHistogram("trpc.time");
+function createSpanAttributes(path, type) {
+	return {
+		path,
+		type
+	};
+}
+function handleProcedureCompletion(span, procedure, meta, logger) {
+	span.setAttributes({ ok: procedure.ok });
+	if (!procedure.ok && procedure.error) {
+		const isInternalError = INTERNAL_ERRORS.has(procedure.error.code);
+		span.setAttributes({
+			error_code: procedure.error.code,
+			internal_error: isInternalError
+		});
+		if (isInternalError) logger?.error({ error: procedure.error }, "[trpc] Internal error");
+		trpcProcedures.add(1, {
+			...meta,
+			error_code: procedure.error.code,
+			ok: false
+		});
+	} else trpcProcedures.add(1, {
+		...meta,
+		ok: true
+	});
+}
+function handleUnexpectedError(error, span, meta, logger, onInternalError) {
+	span.setAttributes({
+		ok: false,
+		unexpected_error: true
+	});
+	logger?.error({ error }, "[trpc] Unexpected error");
+	trpcProcedures.add(1, {
+		...meta,
+		ok: false,
+		error_code: "UNEXPECTED_ERROR"
+	});
+	onInternalError?.(error);
+	throw error;
+}
+/**
+* Creates a middleware for monitoring tRPC procedures using OpenTelemetry.
+*
+* @param pluginOpts - Optional configuration for the middleware.
+*/
+function createMonitoringMiddleware(pluginOpts) {
+	const t = initTRPC.create();
+	const { onInternalError, logger } = pluginOpts ?? {};
+	return t.procedure.use((opts) => {
+		return tracer.startActiveSpan(`trpc/${opts.path} (${opts.type})`, async (span) => {
+			const start = performance.now();
+			const meta = createSpanAttributes(opts.path, opts.type);
+			const procedureLogger = logger?.child({ procedure: meta });
+			span.setAttributes(meta);
+			try {
+				const procedure = await opts.next({ ctx: { logger: procedureLogger } });
+				handleProcedureCompletion(span, procedure, meta, procedureLogger);
+				return procedure;
+			} catch (error) {
+				handleUnexpectedError(error, span, meta, procedureLogger, onInternalError);
+				throw error;
+			} finally {
+				span.end();
+				const end = performance.now();
+				trpcTime.record(end - start, meta);
+			}
+		});
+	});
+}
+
+//#endregion
+export { createMonitoringMiddleware };

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "trpc-monitoring-middleware",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "A tRPC middleware for monitoring procedures",
+  "author": "Alexis Tacnet <alexistacnet@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/fuegoio/trpc-monitoring-middleware#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fuegoio/trpc-monitoring-middleware.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fuegoio/trpc-monitoring-middleware/issues"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "bumpp": "^10.3.2",
+    "tsdown": "^0.18.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "*",
+    "@trpc/server": "^11.0.0"
+  }
+}