Merge pull request #1053 from aws/sync-preview/merge-main-20260430

sync-preview: merge main into preview

Author: avi-alpert

integ-tests/help.test.ts

@@ -1,5 +1,10 @@
+import { spawnAndCollect } from '../src/test-utils/cli-runner.js';
 import { runCLI } from '../src/test-utils/index.js';
-import { describe, expect, it } from 'vitest';
+import { readdirSync } from 'node:fs';
+import { mkdir, readFile, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 
 const COMMANDS = [
   'create',
@@ -38,3 +43,59 @@ describe('CLI help', () => {
     }
   });
 });
+
+describe('help modes telemetry', () => {
+  let testConfigDir: string;
+  const cliPath = join(__dirname, '..', 'dist', 'cli', 'index.mjs');
+
+  beforeAll(async () => {
+    testConfigDir = join(tmpdir(), `agentcore-help-telemetry-${Date.now()}`);
+    await mkdir(testConfigDir, { recursive: true });
+  });
+  afterAll(() => rm(testConfigDir, { recursive: true, force: true }));
+
+  function run(args: string[], extraEnv: Record<string, string> = {}) {
+    return spawnAndCollect('node', [cliPath, ...args], tmpdir(), {
+      AGENTCORE_SKIP_INSTALL: '1',
+      AGENTCORE_CONFIG_DIR: testConfigDir,
+      ...extraEnv,
+    });
+  }
+
+  it('writes JSONL audit file when audit is enabled via env var', async () => {
+    const result = await run(['help', 'modes'], { AGENTCORE_TELEMETRY_AUDIT: '1' });
+    expect(result.exitCode).toBe(0);
+
+    const telemetryDir = join(testConfigDir, 'telemetry');
+    const files = readdirSync(telemetryDir).filter(f => f.startsWith('help-'));
+    expect(files).toHaveLength(1);
+
+    const content = await readFile(join(telemetryDir, files[0]!), 'utf-8');
+    const entry = JSON.parse(content.trim());
+    expect(entry.attrs).toMatchObject({
+      'service.name': 'agentcore-cli',
+      'agentcore-cli.mode': 'cli',
+      command_group: 'help',
+      command: 'help.modes',
+      exit_reason: 'success',
+    });
+    expect(entry.attrs['agentcore-cli.session_id']).toBeDefined();
+    expect(entry.attrs['os.type']).toBeDefined();
+    expect(entry.value).toBeGreaterThanOrEqual(0);
+  });
+
+  it('does not write audit file when audit is not enabled', async () => {
+    const telemetryDir = join(testConfigDir, 'telemetry');
+    await rm(telemetryDir, { recursive: true, force: true });
+
+    const result = await run(['help', 'modes']);
+    expect(result.exitCode).toBe(0);
+
+    try {
+      const files = readdirSync(telemetryDir);
+      expect(files).toHaveLength(0);
+    } catch {
+      // telemetry dir doesn't exist — correct
+    }
+  });
+});

src/cli/cli.ts

@@ -23,6 +23,7 @@ import { registerValidate } from './commands/validate';
 import { PACKAGE_VERSION } from './constants';
 import { getOrCreateInstallationId } from './global-config';
 import { ALL_PRIMITIVES } from './primitives';
+import { TelemetryClientAccessor } from './telemetry';
 import { App } from './tui/App';
 import { LayoutProvider } from './tui/context';
 import { COMMAND_DESCRIPTIONS } from './tui/copy';
@@ -228,7 +229,12 @@ export const main = async (argv: string[]) => {
     printTelemetryNotice();
   }
 
-  await program.parseAsync(argv);
+  TelemetryClientAccessor.init(args[0] ?? 'unknown');
+  try {
+    await program.parseAsync(argv);
+  } finally {
+    await TelemetryClientAccessor.shutdown();
+  }
 
   // Telemetry notice already printed above; only run update check here.
   await printPostCommandNotices(false, updateCheck);

src/cli/commands/help/command.tsx

@@ -1,3 +1,4 @@
+import { TelemetryClientAccessor } from '../../telemetry/client-accessor.js';
 import type { Command } from '@commander-js/extra-typings';
 
 const MODES_HELP = `
@@ -41,15 +42,23 @@ export const registerHelp = (program: Command) => {
   const helpCmd = program
     .command('help')
     .description('Display help topics')
-    .action(() => {
-      console.log('Available help topics: modes');
-      console.log('Run `agentcore help <topic>` for details.');
+    .action(async () => {
+      const client = await TelemetryClientAccessor.get();
+      await client.withCommandRun('help', () => {
+        console.log('Available help topics: modes');
+        console.log('Run `agentcore help <topic>` for details.');
+        return {};
+      });
     });
 
   helpCmd
     .command('modes')
     .description('Explain interactive vs non-interactive modes')
-    .action(() => {
-      console.log(MODES_HELP);
+    .action(async () => {
+      const client = await TelemetryClientAccessor.get();
+      await client.withCommandRun('help.modes', () => {
+        console.log(MODES_HELP);
+        return {};
+      });
     });
 };

src/cli/operations/dev/web-ui/handlers/invocations.ts

@@ -76,6 +76,7 @@ export async function handleInvocations(
   return new Promise<void>((resolve, reject) => {
     const headers: Record<string, string> = {
       'Content-Type': 'application/json',
+      Accept: 'text/event-stream, */*',
       'x-amzn-bedrock-agentcore-runtime-session-id': sessionId ?? randomUUID(),
     };
     if (userId) {

src/cli/telemetry/__tests__/filesystem-sink.test.ts

@@ -0,0 +1,95 @@
+import { createTempConfig } from '../../__tests__/helpers/temp-config';
+import { resolveAuditFilePath } from '../config';
+import { FileSystemSink } from '../sinks/filesystem-sink';
+import { readFile } from 'fs/promises';
+import { join } from 'node:path';
+import { afterAll, beforeEach, describe, expect, it } from 'vitest';
+
+const tmp = createTempConfig('fs-sink');
+const outputDir = join(tmp.configDir, 'telemetry');
+
+function createSink(opts: { dir?: string; log?: (msg: string) => void } = {}) {
+  const filePath = join(opts.dir ?? outputDir, 'test-session.json');
+  return new FileSystemSink({ filePath, log: opts.log });
+}
+
+function readJsonl(path: string): Promise<unknown[]> {
+  return readFile(path, 'utf-8').then(data =>
+    data
+      .trim()
+      .split('\n')
+      .map(line => JSON.parse(line))
+  );
+}
+
+describe('FileSystemSink', () => {
+  beforeEach(() => tmp.setup());
+  afterAll(() => tmp.cleanup());
+
+  it('writes each record as a JSONL line on disk', async () => {
+    const sink = createSink();
+    sink.record(42, { command_group: 'deploy', command: 'deploy', exit_reason: 'success' });
+    await sink.flush();
+
+    const entries = await readJsonl(join(outputDir, 'test-session.json'));
+    expect(entries).toHaveLength(1);
+    expect(entries[0]).toMatchObject({
+      value: 42,
+      attrs: { command_group: 'deploy', command: 'deploy', exit_reason: 'success' },
+    });
+  });
+
+  it('appends multiple records as separate lines', async () => {
+    const sink = createSink();
+    sink.record(10, { command_group: 'add', command: 'add.agent' });
+    sink.record(20, { command_group: 'add', command: 'add.memory' });
+    await sink.flush();
+
+    const entries = await readJsonl(join(outputDir, 'test-session.json'));
+    expect(entries).toHaveLength(2);
+    expect(entries[0]).toMatchObject({ value: 10 });
+    expect(entries[1]).toMatchObject({ value: 20 });
+  });
+
+  it('creates output directory if it does not exist', async () => {
+    const nested = join(tmp.testDir, 'deep', 'nested', 'telemetry');
+    const filePath = join(nested, 'test.json');
+    const sink = new FileSystemSink({ filePath });
+    sink.record(1, { command_group: 'status', command: 'status' });
+    await sink.flush();
+
+    const entries = await readJsonl(filePath);
+    expect(entries).toHaveLength(1);
+  });
+
+  it('flush is a no-op when no records exist', async () => {
+    const sink = createSink();
+    await expect(sink.flush()).resolves.toBeUndefined();
+  });
+
+  it('shutdown logs audit message when records were written', async () => {
+    const logged: string[] = [];
+    const sink = createSink({ log: msg => logged.push(msg) });
+    sink.record(99, { command_group: 'invoke', command: 'invoke' });
+    await sink.shutdown();
+
+    expect(logged).toHaveLength(1);
+    expect(logged[0]).toContain('[audit mode]');
+    expect(logged[0]).toContain('test-session.json');
+  });
+
+  it('shutdown does not log when no records were written', async () => {
+    const logged: string[] = [];
+    const sink = createSink({ log: msg => logged.push(msg) });
+    await sink.shutdown();
+
+    expect(logged).toHaveLength(0);
+  });
+});
+
+describe('resolveAuditFilePath', () => {
+  it('joins outputDir, entrypoint, and sessionId into a JSON file path', () => {
+    const path = resolveAuditFilePath('/home/user/.agentcore/telemetry', 'deploy', 'abc-123');
+    expect(path).toBe('/home/user/.agentcore/telemetry/deploy-abc-123.json');
+  });
+});

src/cli/telemetry/client-accessor.ts

@@ -0,0 +1,49 @@
+import { GLOBAL_CONFIG_DIR, readGlobalConfig } from '../global-config.js';
+import { TelemetryClient } from './client.js';
+import { resolveAuditFilePath, resolveResourceAttributes } from './config.js';
+import { FileSystemSink } from './sinks/filesystem-sink.js';
+import { CompositeSink } from './sinks/metric-sink.js';
+import { join } from 'path';
+
+/**
+ * Manages a singleton TelemetryClient. Call init() at startup to configure,
+ * get() from command handlers to obtain the client, and shutdown() on exit.
+ * get() lazily initializes if init() was never called.
+ */
+export class TelemetryClientAccessor {
+  private static clientPromise: Promise<TelemetryClient> | undefined;
+
+  static init(entrypoint: string, mode: 'cli' | 'tui' = 'cli'): void {
+    this.clientPromise = createClient(entrypoint, mode);
+  }
+
+  static get(): Promise<TelemetryClient> {
+    this.clientPromise ??= createClient('unknown');
+    return this.clientPromise;
+  }
+
+  static async shutdown(): Promise<void> {
+    if (this.clientPromise) {
+      const client = await this.clientPromise;
+      await client.shutdown();
+    }
+  }
+}
+
+async function createClient(entrypoint: string, mode: 'cli' | 'tui' = 'cli'): Promise<TelemetryClient> {
+  const [resource, config] = await Promise.all([resolveResourceAttributes(mode), readGlobalConfig()]);
+
+  const sinks = [];
+  const audit = process.env.AGENTCORE_TELEMETRY_AUDIT === '1' || config.telemetry?.audit === true;
+
+  if (audit) {
+    const filePath = resolveAuditFilePath(
+      join(GLOBAL_CONFIG_DIR, 'telemetry'),
+      entrypoint,
+      resource['agentcore-cli.session_id']
+    );
+    sinks.push(new FileSystemSink({ filePath, resource }));
+  }
+
+  return new TelemetryClient(new CompositeSink(sinks));
+}

src/cli/telemetry/config.ts

@@ -3,6 +3,7 @@ import { getOrCreateInstallationId, readGlobalConfig } from '../global-config.js
 import { type ResourceAttributes, ResourceAttributesSchema } from './schemas/common-attributes.js';
 import { randomUUID } from 'crypto';
 import os from 'os';
+import { join } from 'path';
 
 // ---------------------------------------------------------------------------
 // Telemetry preference (opt-in / opt-out)
@@ -59,3 +60,7 @@ export async function resolveResourceAttributes(mode: 'cli' | 'tui'): Promise<Re
     'node.version': process.version,
   });
 }
+
+export function resolveAuditFilePath(outputDir: string, entrypoint: string, sessionId: string): string {
+  return join(outputDir, `${entrypoint}-${sessionId}.json`);
+}

src/cli/telemetry/index.ts

@@ -1,6 +1,8 @@
-export { resolveTelemetryPreference, resolveResourceAttributes } from './config.js';
+export { resolveTelemetryPreference, resolveResourceAttributes, resolveAuditFilePath } from './config.js';
 export type { TelemetryPreference } from './config.js';
+export { TelemetryClientAccessor } from './client-accessor.js';
 export { TelemetryClient, CANCELLED } from './client.js';
 export { type MetricSink, CompositeSink } from './sinks/metric-sink.js';
 export { OtelMetricSink, type OtelMetricSinkConfig } from './sinks/otel-metric-sink.js';
+export { FileSystemSink, type FileSystemSinkConfig } from './sinks/filesystem-sink.js';
 export { classifyError, isUserError } from './error-classification.js';

src/cli/telemetry/schemas/command-run.ts

@@ -193,6 +193,7 @@ export const COMMAND_SCHEMAS = {
   package: NoAttrs,
   validate: NoAttrs,
   'help.modes': NoAttrs,
+  help: NoAttrs,
   'remove.agent': NoAttrs,
   'remove.memory': NoAttrs,
   'remove.credential': NoAttrs,

src/cli/telemetry/sinks/filesystem-sink.ts

@@ -0,0 +1,48 @@
+import type { MetricSink } from './metric-sink.js';
+import { appendFile, mkdir } from 'fs/promises';
+import { dirname } from 'path';
+
+export interface FileSystemSinkConfig {
+  filePath: string;
+  resource?: Record<string, string | number>;
+  log?: (message: string) => void;
+}
+
+export class FileSystemSink implements MetricSink {
+  private readonly filePath: string;
+  private readonly resource: Record<string, string | number>;
+  private readonly log: (message: string) => void;
+  private hasRecords = false;
+
+  constructor(config: FileSystemSinkConfig) {
+    this.filePath = config.filePath;
+    this.resource = config.resource ?? {};
+    this.log = config.log ?? (msg => console.log(msg));
+  }
+
+  record(value: number, attrs: Record<string, string | number>): void {
+    this.hasRecords = true;
+    this.pendingWrite = this.pendingWrite.then(() =>
+      this.appendEntry({ value, attrs: { ...this.resource, ...attrs } })
+    );
+  }
+
+  async flush(): Promise<void> {
+    await this.pendingWrite;
+  }
+
+  async shutdown(): Promise<void> {
+    await this.pendingWrite;
+    if (this.hasRecords) {
+      this.log(`[audit mode] Telemetry written to ${this.filePath}`);
+    }
+  }
+
+  // Promise chain that serializes async writes so record() can stay synchronous.
+  private pendingWrite: Promise<void> = Promise.resolve();
+
+  private async appendEntry(entry: { value: number; attrs: Record<string, string | number> }): Promise<void> {
+    await mkdir(dirname(this.filePath), { recursive: true });
+    await appendFile(this.filePath, JSON.stringify(entry) + '\n');
+  }
+}