@monocle.sh/adonisjs-agent 1.2.3 → 1.3.0

package/dist/_virtual/_rolldown/runtime.mjs

@@ -0,0 +1,28 @@
+import "node:module";
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+//#endregion
+export { __exportAll, __reExport };

package/dist/index.d.mts

@@ -1,9 +1,7 @@
-import { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig } from "./src/types/config.mjs";
 import { defineConfig } from "./src/define_config.mjs";
-import { SpanAllOptions, SpanOptions } from "./src/types/decorators.mjs";
 import { Monocle } from "./src/monocle.mjs";
 import { configure } from "./configure.mjs";
 import { extractTraceContext, getCurrentSpan, handleError, injectTraceContext, otelLoggingPreset, record, recordEvent, setAttributes } from "./helpers.mjs";
 import { span, spanAll } from "./decorators.mjs";
 import { destinations } from "@adonisjs/otel";
-export { type BatchConfig, type CliTracingConfig, type HostMetricsConfig, Monocle, type MonocleConfig, type SpanAllOptions, type SpanOptions, configure, defineConfig, destinations, extractTraceContext, getCurrentSpan, handleError, injectTraceContext, otelLoggingPreset, record, recordEvent, setAttributes, span, spanAll };
+export { Monocle, configure, defineConfig, destinations, extractTraceContext, getCurrentSpan, handleError, injectTraceContext, otelLoggingPreset, record, recordEvent, setAttributes, span, spanAll };

package/dist/src/define_config.mjs

@@ -1,3 +1,4 @@
+import { buildHttpInstrumentationConfig } from "./http_instrumentation_config.mjs";
 import { destinations } from "@adonisjs/otel";
 //#region src/define_config.ts
 const DEFAULT_BATCH_CONFIG = {
@@ -6,46 +7,17 @@ const DEFAULT_BATCH_CONFIG = {
 	exportTimeoutMillis: 3e4,
 	maxQueueSize: 2048
 };
-/**
-* Extracts a header value from either ServerResponse (getHeader) or IncomingMessage (headers object).
-*/
-function getHeader(response, name) {
-	if ("getHeader" in response && typeof response.getHeader === "function") {
-		const value = response.getHeader(name);
-		if (typeof value === "string") return value;
-	}
-	if ("headers" in response && response.headers) {
-		const value = response.headers[name];
-		if (typeof value === "string") return value;
-	}
-}
-/**
-* Detects the connection type based on response headers.
-* Returns 'sse' for Server-Sent Events, 'websocket' for WebSocket upgrades,
-* or undefined for standard HTTP connections.
-*/
-function detectConnectionType(response) {
-	if (getHeader(response, "content-type")?.includes("text/event-stream")) return "sse";
-	if (getHeader(response, "upgrade")?.toLowerCase() === "websocket") return "websocket";
+function resolveSdkVersion() {
+	return "1.3.0";
 }
-/**
-* Creates a response hook that detects long-running HTTP connections
-* (SSE and WebSocket) and adds the `http.connection_type` attribute.
-*/
-function createConnectionTypeHook(userHook) {
-	return (span, response) => {
-		const connectionType = detectConnectionType(response);
-		if (connectionType) span.setAttribute("http.connection_type", connectionType);
-		userHook?.(span, response);
+function buildNodejsResourceAttributes() {
+	const attributes = {
+		"monocle.language.name": "javascript",
+		"monocle.framework.name": "adonisjs"
 	};
-}
-/**
-* Extracts the user-defined response hook from HTTP instrumentation config.
-*/
-function extractUserResponseHook(httpConfig) {
-	if (typeof httpConfig !== "object" || httpConfig === null) return;
-	if (!("responseHook" in httpConfig)) return;
-	return httpConfig.responseHook;
+	const sdkVersion = resolveSdkVersion();
+	if (sdkVersion) attributes["telemetry.sdk.version"] = sdkVersion;
+	return attributes;
 }
 /**
 * Define and validate Monocle agent configuration.
@@ -66,14 +38,14 @@ function defineConfig(config) {
 		...isDev ? devBatchConfig : DEFAULT_BATCH_CONFIG,
 		...config.batch
 	};
-	const httpConfig = config.instrumentations?.["@opentelemetry/instrumentation-http"];
-	const userResponseHook = extractUserResponseHook(httpConfig);
+	const httpInstrumentationConfig = buildHttpInstrumentationConfig(config);
+	const resourceAttributes = {
+		...buildNodejsResourceAttributes(),
+		...config.resourceAttributes
+	};
 	const instrumentations = {
 		...config.instrumentations,
-		"@opentelemetry/instrumentation-http": {
-			...typeof httpConfig === "object" && httpConfig !== null ? httpConfig : {},
-			responseHook: createConnectionTypeHook(userResponseHook)
-		}
+		"@opentelemetry/instrumentation-http": { ...httpInstrumentationConfig }
 	};
 	const headers = { "x-monocle-env": environment };
 	if (config.apiKey) headers["x-api-key"] = config.apiKey;
@@ -91,6 +63,7 @@ function defineConfig(config) {
 		...config,
 		endpoint,
 		environment,
+		resourceAttributes,
 		instrumentations,
 		destinations: {
 			...config.destinations,

package/dist/src/exception_reporter.mjs

@@ -1,5 +1,5 @@
-import is from "@sindresorhus/is";
 import { ExceptionReporter } from "@monocle.sh/otel-utils";
+import is from "@sindresorhus/is";
 //#region src/exception_reporter.ts
 /**
 * Convert any unknown error to an HttpError-like object.

package/dist/src/http_instrumentation_config.mjs

@@ -0,0 +1,196 @@
+import { HttpBodyCapture, HttpUrlSanitizer } from "@monocle.sh/otel-utils";
+//#region src/http_instrumentation_config.ts
+/**
+* Builds the effective HTTP instrumentation config used by the Adonis agent.
+*/
+var HttpInstrumentationConfigBuilder = class {
+	#config;
+	#httpConfig;
+	constructor(config) {
+		this.#config = config;
+		this.#httpConfig = this.#resolveHttpConfig();
+	}
+	/**
+	* Resolves the effective HTTP config, with low-level instrumentation overrides winning.
+	*/
+	#resolveHttpConfig() {
+		const topLevelHttpConfig = this.#config.http;
+		const instrumentationHttpConfig = this.#config.instrumentations?.["@opentelemetry/instrumentation-http"];
+		if (instrumentationHttpConfig?.enabled === false) return instrumentationHttpConfig;
+		if (typeof instrumentationHttpConfig === "object" && instrumentationHttpConfig !== null) {
+			if (topLevelHttpConfig === false) return instrumentationHttpConfig;
+			if (typeof topLevelHttpConfig !== "object" || topLevelHttpConfig === null) return instrumentationHttpConfig;
+			return {
+				...topLevelHttpConfig,
+				...instrumentationHttpConfig
+			};
+		}
+		if (topLevelHttpConfig === false) return topLevelHttpConfig;
+		if (typeof topLevelHttpConfig !== "object" || topLevelHttpConfig === null) return instrumentationHttpConfig;
+		return topLevelHttpConfig;
+	}
+	/**
+	* Reads custom URL sanitization rules from the effective config.
+	*/
+	#resolveHttpUrlConfig() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return;
+		return this.#httpConfig.sanitizeUrls;
+	}
+	/**
+	* Reads custom body capture rules from the effective config.
+	*/
+	#resolveHttpBodyConfig() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return;
+		return this.#httpConfig.captureBodies;
+	}
+	/**
+	* Determines whether HTTP instrumentation should remain enabled.
+	*/
+	#resolveEnabled() {
+		if (this.#httpConfig === false) return false;
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return true;
+		if ("enabled" in this.#httpConfig && this.#httpConfig.enabled === false) return false;
+		return true;
+	}
+	/**
+	* Returns the object-shaped portion of the effective config for spreading into the final config.
+	*/
+	#getObjectConfig() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return {};
+		return this.#httpConfig;
+	}
+	/**
+	* Extracts a user-defined request hook from the effective config.
+	*/
+	#extractUserRequestHook() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return;
+		if (!("requestHook" in this.#httpConfig)) return;
+		return this.#httpConfig.requestHook;
+	}
+	/**
+	* Extracts a user-defined response hook from the effective config.
+	*/
+	#extractUserResponseHook() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return;
+		if (!("responseHook" in this.#httpConfig)) return;
+		return this.#httpConfig.responseHook;
+	}
+	/**
+	* Extracts a user-defined custom-attributes hook from the effective config.
+	*/
+	#extractUserApplyCustomAttributesOnSpan() {
+		if (typeof this.#httpConfig !== "object" || this.#httpConfig === null) return;
+		if (!("applyCustomAttributesOnSpan" in this.#httpConfig)) return;
+		return this.#httpConfig.applyCustomAttributesOnSpan;
+	}
+	/**
+	* Extracts a header value from either ServerResponse or IncomingMessage.
+	*/
+	#getHeader(response, name) {
+		if ("getHeader" in response && typeof response.getHeader === "function") {
+			const value = response.getHeader(name);
+			if (typeof value === "string") return value;
+		}
+		if ("headers" in response && response.headers) {
+			const value = response.headers[name];
+			if (typeof value === "string") return value;
+		}
+	}
+	/**
+	* Detects whether the response is an SSE or websocket connection.
+	*/
+	#detectConnectionType(response) {
+		if (this.#getHeader(response, "content-type")?.includes("text/event-stream")) return "sse";
+		if (this.#getHeader(response, "upgrade")?.toLowerCase() === "websocket") return "websocket";
+	}
+	/**
+	* Builds the hook that tags long-lived HTTP connections.
+	*/
+	#createConnectionTypeHook(userHook) {
+		return (span, response) => {
+			const connectionType = this.#detectConnectionType(response);
+			if (connectionType) span.setAttribute("http.connection_type", connectionType);
+			userHook?.(span, response);
+		};
+	}
+	/**
+	* Builds the effective request hook with URL sanitization, body capture, and user hooks.
+	*/
+	#createRequestHook(options) {
+		const bodyCaptureHook = options.bodyCapture.createRequestHook();
+		if (!bodyCaptureHook && !options.userHook && !options.urlSanitizationEnabled) return;
+		return (span, request) => {
+			options.urlSanitizer.sanitizeSpanFromRequest({
+				span,
+				request
+			});
+			bodyCaptureHook?.(span, request);
+			options.userHook?.(span, request);
+		};
+	}
+	/**
+	* Builds the effective response hook with body capture and connection tagging.
+	*/
+	#createResponseHook(options) {
+		const bodyCaptureHook = options.bodyCapture.createResponseHook();
+		const connectionTypeHook = this.#createConnectionTypeHook(options.userHook);
+		if (!bodyCaptureHook && !options.userHook) return connectionTypeHook;
+		return (span, response) => {
+			bodyCaptureHook?.(span, response);
+			connectionTypeHook(span, response);
+		};
+	}
+	/**
+	* Builds the hook that flushes body capture before the span closes.
+	*/
+	#createApplyCustomAttributesOnSpan(options) {
+		return (span, request, response) => {
+			options.bodyCapture.applyCustomAttributesOnSpan({
+				span,
+				request,
+				response
+			});
+			options.userHook?.(span, request, response);
+		};
+	}
+	/**
+	* Produces the final HTTP instrumentation config consumed by Adonis OTel.
+	*/
+	build() {
+		const enabled = this.#resolveEnabled();
+		const baseConfig = this.#getObjectConfig();
+		if (!enabled) return {
+			...baseConfig,
+			enabled: false
+		};
+		const bodyCapture = new HttpBodyCapture(this.#resolveHttpBodyConfig());
+		const urlConfig = this.#resolveHttpUrlConfig();
+		const urlSanitizer = new HttpUrlSanitizer(urlConfig);
+		return {
+			...baseConfig,
+			enabled: true,
+			requestHook: this.#createRequestHook({
+				bodyCapture,
+				urlSanitizer,
+				urlSanitizationEnabled: urlConfig !== void 0,
+				userHook: this.#extractUserRequestHook()
+			}),
+			responseHook: this.#createResponseHook({
+				bodyCapture,
+				userHook: this.#extractUserResponseHook()
+			}),
+			applyCustomAttributesOnSpan: this.#createApplyCustomAttributesOnSpan({
+				bodyCapture,
+				userHook: this.#extractUserApplyCustomAttributesOnSpan()
+			})
+		};
+	}
+};
+/**
+* Builds the effective HTTP instrumentation config from top-level and low-level options.
+*/
+function buildHttpInstrumentationConfig(config) {
+	return new HttpInstrumentationConfigBuilder(config).build();
+}
+//#endregion
+export { buildHttpInstrumentationConfig };

package/dist/src/monocle.mjs

@@ -1,9 +1,9 @@
 import { ExceptionReporter } from "./exception_reporter.mjs";
+import { extractContextLines } from "@monocle.sh/otel-utils";
 import { randomUUID } from "node:crypto";
 import { trace } from "@opentelemetry/api";
 import { SeverityNumber, logs } from "@opentelemetry/api-logs";
 import { setUser } from "@adonisjs/otel/helpers";
-import { extractContextLines } from "@monocle.sh/otel-utils";
 //#region src/monocle.ts
 const DEFAULT_CONTEXT_LINES = 7;
 const LOGGER_NAME = "@monocle.sh/agent";

package/dist/src/types/config.d.mts

@@ -1,5 +1,6 @@
+import { HttpBodyCaptureConfig, HttpUrlSanitizationConfig } from "@monocle.sh/otel-utils";
 import { BentoCacheInstrumentationConfig } from "@bentocache/otel/types";
-import { DestinationMap, OtelConfig } from "@adonisjs/otel/types";
+import { DestinationMap, HttpInstrumentationConfig, InstrumentationsConfig, OtelConfig } from "@adonisjs/otel/types";
 import { BullMQInstrumentationConfig } from "@monocle.sh/instrumentation-bullmq";
 
 //#region src/types/config.d.ts
@@ -103,7 +104,32 @@ interface AiInstrumentationConfig {
   recordOutputs?: boolean;
 }
 type BullMQAgentConfig = BullMQInstrumentationConfig;
-interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExporter'> {
+/**
+ * Extended HTTP instrumentation config consumed by the Monocle agent.
+ */
+interface MonocleHttpInstrumentationConfig extends HttpInstrumentationConfig {
+  /**
+   * URL sanitization rules applied before HTTP spans are exported.
+   */
+  sanitizeUrls?: false | HttpUrlSanitizationConfig;
+  /**
+   * HTTP body capture rules for request and response payloads.
+   */
+  captureBodies?: false | HttpBodyCaptureConfig;
+}
+/**
+ * Instrumentation map extended with Monocle's HTTP instrumentation options.
+ */
+type BaseInstrumentationValue = NonNullable<InstrumentationsConfig>[string & {}];
+type MonocleInstrumentationsConfig = Omit<NonNullable<InstrumentationsConfig>, '@opentelemetry/instrumentation-http'> & {
+  '@opentelemetry/instrumentation-http'?: MonocleHttpInstrumentationConfig | {
+    enabled: false;
+  };
+  [key: string & {}]: BaseInstrumentationValue | MonocleHttpInstrumentationConfig | {
+    enabled: false;
+  } | undefined;
+};
+interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExporter' | 'instrumentations'> {
   /**
    * Enable local DevTools mode.
    * Sends telemetry to Monocle DevTools (localhost:4200) with no compression.
@@ -137,6 +163,16 @@ interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExport
    * Monocle destination is always injected automatically and cannot be removed.
    */
   destinations?: DestinationMap;
+  /**
+   * Instrumentation overrides and low-level escape hatches.
+   */
+  instrumentations?: MonocleInstrumentationsConfig;
+  /**
+   * High-level HTTP tracing configuration.
+   * This is the recommended way to configure ignored URLs, URL sanitization,
+   * and HTTP body capture.
+   */
+  http?: false | MonocleHttpInstrumentationConfig;
   /**
    * Host metrics configuration (CPU, Memory, Network, etc.).
    * Set to `false` to disable, or pass config object.
@@ -197,4 +233,4 @@ interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExport
   ai?: false | AiInstrumentationConfig;
 }
 //#endregion
-export { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig };
+export { AiInstrumentationConfig, BatchConfig, BullMQAgentConfig, CacheInstrumentationConfig, CliTracingConfig, HostMetricsConfig, MailInstrumentationConfig, MonocleConfig, MonocleHttpInstrumentationConfig, MonocleInstrumentationsConfig, QueueInstrumentationConfig };

package/dist/src/types/main.d.mts

@@ -1,3 +1,12 @@
-import { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig } from "./config.mjs";
+import { AiInstrumentationConfig, BatchConfig, BullMQAgentConfig, CacheInstrumentationConfig, CliTracingConfig, HostMetricsConfig, MailInstrumentationConfig, MonocleConfig, MonocleHttpInstrumentationConfig, MonocleInstrumentationsConfig, QueueInstrumentationConfig } from "./config.mjs";
+import { CaptureContext, CaptureExceptionContext, CaptureMessageContext, MessageLevel, MonocleUser } from "./monocle.mjs";
 import { SpanAllOptions, SpanOptions } from "./decorators.mjs";
-import { CaptureContext, CaptureExceptionContext, CaptureMessageContext, MessageLevel, MonocleUser } from "./monocle.mjs";
+export * from "@monocle.sh/otel-utils";
+
+//#region src/types/main.d.ts
+declare namespace main_d_exports {
+  export { AiInstrumentationConfig, BatchConfig, BullMQAgentConfig, CacheInstrumentationConfig, CaptureContext, CaptureExceptionContext, CaptureMessageContext, CliTracingConfig, HostMetricsConfig, MailInstrumentationConfig, MessageLevel, MonocleConfig, MonocleHttpInstrumentationConfig, MonocleInstrumentationsConfig, MonocleUser, QueueInstrumentationConfig, SpanAllOptions, SpanOptions };
+}
+import * as import__monocle_sh_otel_utils from "@monocle.sh/otel-utils";
+//#endregion
+export { import__monocle_sh_otel_utils as main_d_exports };

package/dist/stubs/config.stub

@@ -5,6 +5,11 @@ import { defineConfig } from '@monocle.sh/adonisjs-agent'
 import env from '#start/env'
 
 export default defineConfig({
+  /**
+   * Enable Monocle Studio for local development.
+   * @see https://docs.monocle.sh/studio/overview
+   */
+  dev: process.env.NODE_ENV === 'development',
   apiKey: env.get('MONOCLE_API_KEY'),
 
   serviceName: env.get('APP_NAME'),

package/dist/types.d.mts

@@ -1,5 +1,14 @@
-import { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig } from "./src/types/config.mjs";
-import { SpanAllOptions, SpanOptions } from "./src/types/decorators.mjs";
+import { BatchConfig, CliTracingConfig, HostMetricsConfig, MonocleConfig, MonocleHttpInstrumentationConfig, MonocleInstrumentationsConfig } from "./src/types/config.mjs";
 import { MonocleUser } from "./src/types/monocle.mjs";
+import { SpanAllOptions, SpanOptions } from "./src/types/decorators.mjs";
+import { main_d_exports } from "./src/types/main.mjs";
 import { DestinationConfig, DestinationMap, DestinationSignal, DestinationSignals, HeadersCarrier, OtelLoggingPresetOptions, OtlpDestinationConfig, OtlpDestinationOptions, UserContextResult } from "@adonisjs/otel/types";
-export { type BatchConfig, type CliTracingConfig, type DestinationConfig, type DestinationMap, type DestinationSignal, type DestinationSignals, type HeadersCarrier, type HostMetricsConfig, type MonocleConfig, type MonocleUser, type OtelLoggingPresetOptions, type OtlpDestinationConfig, type OtlpDestinationOptions, type SpanAllOptions, type SpanOptions, type UserContextResult };
+type HttpBodyCaptureConfig = main_d_exports.HttpBodyCaptureConfig;
+type HttpBodyCaptureSideConfig = main_d_exports.HttpBodyCaptureSideConfig;
+type HttpBodyInfo = main_d_exports.HttpBodyInfo;
+type HttpBodyKind = main_d_exports.HttpBodyKind;
+type HttpBodyRedactionConfig = main_d_exports.HttpBodyRedactionConfig;
+type HttpBodyRedactor = main_d_exports.HttpBodyRedactor;
+type HttpUrlSanitizationConfig = main_d_exports.HttpUrlSanitizationConfig;
+type HttpUrlSanitizerHook = main_d_exports.HttpUrlSanitizerHook;
+export { type BatchConfig, type CliTracingConfig, type DestinationConfig, type DestinationMap, type DestinationSignal, type DestinationSignals, type HeadersCarrier, type HostMetricsConfig, type HttpBodyCaptureConfig, type HttpBodyCaptureSideConfig, type HttpBodyInfo, type HttpBodyKind, type HttpBodyRedactionConfig, type HttpBodyRedactor, type HttpUrlSanitizationConfig, type HttpUrlSanitizerHook, type MonocleConfig, type MonocleHttpInstrumentationConfig, type MonocleInstrumentationsConfig, type MonocleUser, type OtelLoggingPresetOptions, type OtlpDestinationConfig, type OtlpDestinationOptions, type SpanAllOptions, type SpanOptions, type UserContextResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocle.sh/adonisjs-agent",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "Monocle agent for AdonisJS - sends telemetry to Monocle cloud",
   "keywords": [
     "adonisjs",
@@ -56,8 +56,8 @@
     "import-in-the-middle": "^3.0.0",
     "@monocle.sh/instrumentation-bullmq": "^0.3.1",
     "@monocle.sh/instrumentation-mcp": "^1.0.1",
-    "@monocle.sh/instrumentation-vercel-ai": "^1.1.1",
-    "@monocle.sh/otel-utils": "^1.0.2"
+    "@monocle.sh/instrumentation-vercel-ai": "^1.1.2",
+    "@monocle.sh/otel-utils": "^1.1.0"
   },
   "devDependencies": {
     "@adonisjs/core": "^7.3.0",