@monocle.sh/adonisjs-agent 1.0.0-beta.5 → 1.0.0-beta.7

package/README.md

@@ -85,7 +85,7 @@ import { defineConfig } from '@monocle.sh/adonisjs-agent'
 import env from '#start/env'
 
 export default defineConfig({
-  // Required: Your Monocle API key
+  // Optional: Your Monocle API key
   apiKey: env.get('MONOCLE_API_KEY'),
 
   // Optional: Custom ingestion endpoint (for development)
@@ -123,7 +123,7 @@ export default defineConfig({
 
 | Variable          | Description                                            | Required |
 | ----------------- | ------------------------------------------------------ | -------- |
-| `MONOCLE_API_KEY` | Your Monocle API key                                   | Yes      |
+| `MONOCLE_API_KEY` | Your Monocle API key                                   | No       |
 | `APP_NAME`        | Service name for identification                        | Yes      |
 | `APP_VERSION`     | Service version (e.g., git sha, semver)                | Yes      |
 | `APP_ENV`         | Environment: `development`, `staging`, or `production` | Yes      |

package/dist/configure.mjs

@@ -53,7 +53,7 @@ async function configure(command) {
 		APP_NAME: "Env.schema.string()",
 		APP_VERSION: "Env.schema.string()",
 		APP_ENV: `Env.schema.enum(['development', 'staging', 'production'] as const)`,
-		MONOCLE_API_KEY: "Env.schema.string()"
+		MONOCLE_API_KEY: "Env.schema.string.optional()"
 	} });
 }
 

package/dist/init.mjs

@@ -69,9 +69,7 @@ async function init(dirname$1) {
 	const manager = OtelManager.create(configWithProcessors);
 	manager?.start();
 	const shutdown = async () => {
-		await manager?.shutdown().catch(() => {
-			console.error("Error during OTEL shutdown");
-		});
+		await manager?.shutdown().catch(() => {});
 	};
 	process.on("beforeExit", shutdown);
 	process.on("SIGINT", async () => {

package/dist/monocle_provider.mjs

@@ -1,4 +1,4 @@
-import { recordExceptionWithContext } from "./src/context_lines.mjs";
+import { ExceptionReporter, toHttpError } from "./src/exception_reporter.mjs";
 import { getCurrentSpan } from "@adonisjs/otel/helpers";
 import OtelMiddleware from "@adonisjs/otel/otel_middleware";
 import { OtelManager } from "@adonisjs/otel";
@@ -26,14 +26,16 @@ var OtelProvider = class {
 	*/
 	#registerExceptionHandler() {
 		const originalReport = ExceptionHandler.prototype.report;
+		const reporter = new ExceptionReporter();
 		ExceptionHandler.macro("report", async function(error, ctx) {
 			const span = getCurrentSpan();
-			if (span && error instanceof Error) {
-				const httpError = this.toHttpError(error);
-				await recordExceptionWithContext({
+			if (span) {
+				const httpError = toHttpError(error);
+				const shouldReport = this.shouldReport(httpError);
+				await reporter.report({
 					span,
 					error,
-					shouldReport: this.shouldReport(httpError)
+					shouldReport
 				});
 			}
 			return originalReport.call(this, error, ctx);

package/dist/src/cli_instrumentation.mjs

@@ -1,4 +1,4 @@
-import { recordExceptionWithContext } from "./context_lines.mjs";
+import { ExceptionReporter } from "./exception_reporter.mjs";
 import { createRequire } from "node:module";
 import { SpanKind, context, trace } from "@opentelemetry/api";
 
@@ -72,9 +72,10 @@ async function instrumentCliCommands(config, appRoot) {
 			try {
 				return await originalExec.call(this);
 			} catch (error) {
-				if (error instanceof Error) await recordExceptionWithContext({
+				await new ExceptionReporter().report({
 					span,
-					error
+					error,
+					shouldReport: true
 				});
 				throw error;
 			} finally {

package/dist/src/context_lines.mjs

@@ -1,5 +1,4 @@
-import { MAX_CAUSE_DEPTH, buildCauseChain, getErrorCause, isErrorLike, stackWithCauses } from "./error_serializer.mjs";
-import { SpanStatusCode } from "@opentelemetry/api";
+import { MAX_CAUSE_DEPTH, getErrorCause, isErrorLike } from "./error_serializer.mjs";
 import { createInterface } from "node:readline";
 import { createReadStream } from "node:fs";
 import { parseStack } from "error-stack-parser-es/lite";
@@ -265,29 +264,6 @@ async function _buildCauseChainWithContext(err, seen, depth, contextLines) {
 	if (cause) return [current, ...await _buildCauseChainWithContext(cause, seen, depth + 1, contextLines)];
 	return [current];
 }
-/**
-* Record an exception on a span with context lines.
-* This replaces `span.recordException()` with an enriched version.
-*/
-async function recordExceptionWithContext(options) {
-	const { span, error, shouldReport = true, contextLines = DEFAULT_CONTEXT_LINES } = options;
-	span.setStatus({
-		code: SpanStatusCode.ERROR,
-		message: error.message
-	});
-	span.setAttribute("monocle.exception.should_report", shouldReport);
-	const causeChain = shouldReport ? await buildCauseChainWithContext(error, contextLines) : buildCauseChain(error);
-	const hasCauses = causeChain.length > 1;
-	const attributes = {
-		"exception.type": error.name,
-		"exception.message": error.message,
-		"exception.stacktrace": hasCauses ? stackWithCauses(error) : error.stack || ""
-	};
-	if (causeChain.length > 0) attributes["monocle.exception.cause_chain"] = JSON.stringify(causeChain);
-	const mainFrames = causeChain[0]?.frames;
-	if (mainFrames && mainFrames.length > 0) attributes["monocle.exception.frames"] = JSON.stringify(mainFrames);
-	span.addEvent("exception", attributes);
-}
 
 //#endregion
-export { recordExceptionWithContext };
+export { buildCauseChainWithContext };

package/dist/src/exception_reporter.mjs

@@ -0,0 +1,52 @@
+import { buildCauseChain, stackWithCauses } from "./error_serializer.mjs";
+import { buildCauseChainWithContext } from "./context_lines.mjs";
+import { SpanStatusCode } from "@opentelemetry/api";
+import is from "@sindresorhus/is";
+
+//#region src/exception_reporter.ts
+const DEFAULT_CONTEXT_LINES = 7;
+/**
+* Convert any unknown error to an HttpError-like object.
+*/
+function toHttpError(error) {
+	const httpError = is.object(error) ? error : new Error(String(error));
+	if (!httpError.message) httpError.message = "Internal server error";
+	if (!httpError.status) httpError.status = 500;
+	return httpError;
+}
+/**
+* Reports exceptions to OpenTelemetry spans with context lines and cause chains.
+*/
+var ExceptionReporter = class {
+	/**
+	* Report an exception on the given span.
+	*/
+	async report(options) {
+		const { span, shouldReport, contextLines = DEFAULT_CONTEXT_LINES } = options;
+		const error = toHttpError(options.error);
+		span.setStatus({
+			code: SpanStatusCode.ERROR,
+			message: error.message
+		});
+		span.setAttribute("monocle.exception.should_report", shouldReport);
+		const causeChain = shouldReport ? await buildCauseChainWithContext(error, contextLines) : buildCauseChain(error);
+		const attributes = this.#buildAttributes(error, causeChain);
+		span.addEvent("exception", attributes);
+	}
+	#buildAttributes(error, causeChain) {
+		const hasCauses = causeChain.length > 1;
+		const attributes = {
+			"exception.type": error.name || "Error",
+			"exception.message": error.message || "",
+			"exception.stacktrace": hasCauses ? stackWithCauses(error) : error.stack || ""
+		};
+		const actualCauses = causeChain.slice(1);
+		if (actualCauses.length > 0) attributes["monocle.exception.cause_chain"] = JSON.stringify(actualCauses);
+		const mainFrames = causeChain[0]?.frames;
+		if (mainFrames && mainFrames.length > 0) attributes["monocle.exception.frames"] = JSON.stringify(mainFrames);
+		return attributes;
+	}
+};
+
+//#endregion
+export { ExceptionReporter, toHttpError };

package/dist/src/monocle.d.mts

@@ -21,7 +21,7 @@ declare class Monocle {
    * This method is async to allow for source context extraction.
    * You can choose to await it or fire-and-forget.
    */
-  static captureException(error: unknown, context?: CaptureExceptionContext): Promise<void>;
+  static captureException(error: unknown, ctx?: CaptureExceptionContext): Promise<void>;
   /**
    * Set user information on the current active span.
    */

package/dist/src/monocle.mjs

@@ -1,4 +1,4 @@
-import { recordExceptionWithContext } from "./context_lines.mjs";
+import { ExceptionReporter } from "./exception_reporter.mjs";
 import { trace } from "@opentelemetry/api";
 import { setUser } from "@adonisjs/otel/helpers";
 
@@ -14,20 +14,21 @@ var Monocle = class {
 	* This method is async to allow for source context extraction.
 	* You can choose to await it or fire-and-forget.
 	*/
-	static async captureException(error, context$1) {
+	static async captureException(error, ctx) {
 		const span = trace.getActiveSpan();
 		if (!span) return;
-		await recordExceptionWithContext({
+		await new ExceptionReporter().report({
 			span,
-			error: error instanceof Error ? error : new Error(String(error))
+			error,
+			shouldReport: true
 		});
-		if (context$1?.user) {
-			if (context$1.user.id) span.setAttribute("user.id", context$1.user.id);
-			if (context$1.user.email) span.setAttribute("user.email", context$1.user.email);
-			if (context$1.user.name) span.setAttribute("user.name", context$1.user.name);
+		if (ctx?.user) {
+			if (ctx.user.id) span.setAttribute("user.id", ctx.user.id);
+			if (ctx.user.email) span.setAttribute("user.email", ctx.user.email);
+			if (ctx.user.name) span.setAttribute("user.name", ctx.user.name);
 		}
-		if (context$1?.tags) for (const [key, value] of Object.entries(context$1.tags)) span.setAttribute(`monocle.tag.${key}`, value);
-		if (context$1?.extra) for (const [key, value] of Object.entries(context$1.extra)) span.setAttribute(`monocle.extra.${key}`, JSON.stringify(value));
+		if (ctx?.tags) for (const [key, value] of Object.entries(ctx.tags)) span.setAttribute(`monocle.tag.${key}`, value);
+		if (ctx?.extra) for (const [key, value] of Object.entries(ctx.extra)) span.setAttribute(`monocle.extra.${key}`, JSON.stringify(value));
 	}
 	/**
 	* Set user information on the current active span.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocle.sh/adonisjs-agent",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.0-beta.7",
   "description": "Monocle agent for AdonisJS - sends telemetry to Monocle cloud",
   "keywords": [
     "adonisjs",
@@ -67,6 +67,7 @@
     "@opentelemetry/sdk-metrics": "^2.2.0",
     "@opentelemetry/sdk-trace-base": "^2.2.0",
     "@opentelemetry/semantic-conventions": "^1.38.0",
+    "@sindresorhus/is": "^7.2.0",
     "error-stack-parser-es": "^1.0.5",
     "import-in-the-middle": "^2.0.1"
   },