@monocle.sh/adonisjs-agent 1.1.0 → 1.2.0

package/dist/configure.mjs

@@ -10,7 +10,12 @@ async function configure(command) {
 	* Publish otel.ts at project root
 	*/
 	await codemods.makeUsingStub(stubsRoot, "otel.stub", {});
-	const serverFile = (await codemods.getTsMorphProject())?.getSourceFile(command.app.makePath("bin/server.ts"));
+	/**
+	* Add otel.ts import as the FIRST import in bin/server.ts
+	* This is critical for auto-instrumentation to work
+	*/
+	const project = await codemods.getTsMorphProject();
+	const serverFile = project?.getSourceFile(command.app.makePath("bin/server.ts"));
 	if (serverFile) {
 		const insertIndex = serverFile.getImportDeclarations()[0]?.getChildIndex() ?? 0;
 		serverFile.insertStatements(insertIndex, [
@@ -24,6 +29,23 @@ async function configure(command) {
 		await serverFile.save();
 	}
 	/**
+	* Add otel.ts import as the FIRST import in bin/console.ts
+	* Required for CLI command tracing to work
+	*/
+	const consoleFile = project?.getSourceFile(command.app.makePath("bin/console.ts"));
+	if (consoleFile) {
+		const insertIndex = consoleFile.getImportDeclarations()[0]?.getChildIndex() ?? 0;
+		consoleFile.insertStatements(insertIndex, [
+			"/**",
+			" * OpenTelemetry initialization - MUST be the first import",
+			" * @see https://opentelemetry.io/docs/languages/js/getting-started/nodejs/",
+			" */",
+			`import '../otel.js'`,
+			""
+		]);
+		await consoleFile.save();
+	}
+	/**
 	* Register the provider in adonisrc.ts
 	*/
 	await codemods.updateRcFile((rcFile) => {

package/dist/init.mjs

@@ -67,14 +67,14 @@ async function init(dirname) {
 	*
 	* Prerequisites for this to work:
 	* 1. App's `bin/console.ts` must import `otel.ts` FIRST (before reflect-metadata)
-	* 2. Config must have `cli.enabled: true`
+	* 2. Config must not have `cli: false` or `cli.enabled: false`
 	*
 	* @see ./cli_instrumentation.ts for implementation details
 	*/
 	const cliConfig = config.cli;
-	if (cliConfig !== false && cliConfig?.enabled) {
+	if (cliConfig !== false && cliConfig?.enabled !== false) {
 		const { instrumentCliCommands } = await import("./src/cli_instrumentation.mjs");
-		await instrumentCliCommands(cliConfig, dirname);
+		await instrumentCliCommands(cliConfig ?? {}, dirname);
 	}
 	/**
 	* Mail Instrumentation

package/dist/src/define_config.mjs

@@ -52,12 +52,18 @@ function extractUserResponseHook(httpConfig) {
 * Returns undefined if no API key is provided (telemetry will be disabled).
 */
 function defineConfig(config) {
-	if (!config.apiKey) return;
-	const endpoint = config.endpoint || "https://ingest.monocle.sh";
+	const isDev = config.dev ?? process.env.NODE_ENV === "development";
+	if (!isDev && !config.apiKey) return;
+	if (isDev) process.env.OTEL_EXPORTER_OTLP_PROTOCOL = "http/json";
+	const endpoint = isDev ? config.endpoint || "http://localhost:4200" : config.endpoint || "https://ingest.monocle.sh";
 	const environment = config.environment || process.env.NODE_ENV || "development";
-	const compression = config.compression === false ? "none" : "gzip";
-	const batchConfig = {
+	const compression = isDev ? "none" : config.compression === false ? "none" : "gzip";
+	const devBatchConfig = {
 		...DEFAULT_BATCH_CONFIG,
+		scheduledDelayMillis: 100
+	};
+	const batchConfig = {
+		...isDev ? devBatchConfig : DEFAULT_BATCH_CONFIG,
 		...config.batch
 	};
 	const httpConfig = config.instrumentations?.["@opentelemetry/instrumentation-http"];
@@ -69,14 +75,13 @@ function defineConfig(config) {
 			responseHook: createConnectionTypeHook(userResponseHook)
 		}
 	};
+	const headers = { "x-monocle-env": environment };
+	if (config.apiKey) headers["x-api-key"] = config.apiKey;
 	const monocleDestination = destinations.otlp({
 		endpoint,
 		signals: "all",
 		compression,
-		headers: {
-			"x-api-key": config.apiKey,
-			"x-monocle-env": environment
-		},
+		headers,
 		maxExportBatchSize: batchConfig.maxExportBatchSize,
 		scheduledDelayMillis: batchConfig.scheduledDelayMillis,
 		exportTimeoutMillis: batchConfig.exportTimeoutMillis,

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

@@ -31,7 +31,7 @@ interface MailInstrumentationConfig {
 interface CliTracingConfig {
   /**
    * Enable CLI command tracing.
-   * @default false
+   * @default true
    */
   enabled?: boolean;
   /**
@@ -104,6 +104,12 @@ interface AiInstrumentationConfig {
 }
 type BullMQAgentConfig = BullMQInstrumentationConfig;
 interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExporter'> {
+  /**
+   * Enable local DevTools mode.
+   * Sends telemetry to Monocle DevTools (localhost:4200) with no compression.
+   * No API key required.
+   */
+  dev?: boolean;
   /**
    * Your Monocle API key. If not provided, telemetry will be disabled.
    * Format: mk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
@@ -151,7 +157,7 @@ interface MonocleConfig extends Omit<OtelConfig, 'traceExporter' | 'metricExport
   /**
    * CLI command tracing configuration.
    * Set to `false` to disable, or pass config object.
-   * @default false
+   * @default { enabled: true, exclude: ['make:*', 'generate:*', 'queue:work', 'queue:listen'] }
    */
   cli?: false | CliTracingConfig;
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocle.sh/adonisjs-agent",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Monocle agent for AdonisJS - sends telemetry to Monocle cloud",
   "keywords": [
     "adonisjs",