@datadog/datadog-ci 2.18.1 → 2.19.0

package/dist/cli.d.ts

@@ -1 +1,3 @@
-export {};
+import { Cli } from 'clipanion';
+declare const cli: Cli<import("clipanion").BaseContext>;
+export { cli };

package/dist/cli.js

@@ -4,9 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
 const fs_1 = __importDefault(require("fs"));
 const clipanion_1 = require("clipanion");
-const BETA_COMMANDS = ['gate'];
+const version_1 = require("./helpers/version");
+const BETA_COMMANDS = ['gate', 'sbom'];
 const onError = (err) => {
     console.log(err);
     process.exitCode = 1;
@@ -16,8 +18,11 @@ process.on('unhandledRejection', onError);
 const cli = new clipanion_1.Cli({
     binaryLabel: 'Datadog CI',
     binaryName: 'datadog-ci',
-    binaryVersion: require('../package.json').version,
+    binaryVersion: version_1.version,
 });
+exports.cli = cli;
+cli.register(clipanion_1.Builtins.HelpCommand);
+cli.register(clipanion_1.Builtins.VersionCommand);
 const commandsPath = `${__dirname}/commands`;
 for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     const betaCommandsEnabled = process.env.DD_BETA_COMMANDS_ENABLED === '1' || process.env.DD_BETA_COMMANDS_ENABLED === 'true';
@@ -26,6 +31,8 @@ for (const commandFolder of fs_1.default.readdirSync(commandsPath)) {
     }
     const commandPath = `${commandsPath}/${commandFolder}`;
     if (fs_1.default.statSync(commandPath).isDirectory()) {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        ;
         require(`${commandPath}/cli`).forEach((command) => cli.register(command));
     }
 }

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,4CAAmB;AAEnB,yCAA6B;AAG7B,MAAM,aAAa,GAAG,CAAC,MAAM,CAAC,CAAA;AAE9B,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO;CAClD,CAAC,CAAA;AAEF,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,OAAO,CAAC,GAAG,WAAW,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KACxF;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AAEnB,yCAAuC;AAGvC,+CAAyC;AAEzC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAEtC,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAE,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAA;AACxC,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAA;AAEzC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC;IAClB,WAAW,EAAE,YAAY;IACzB,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,iBAAO;CACvB,CAAC,CAAA;AA2BM,kBAAG;AAzBX,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,WAAW,CAAC,CAAA;AAClC,GAAG,CAAC,QAAQ,CAAC,oBAAQ,CAAC,cAAc,CAAC,CAAA;AAErC,MAAM,YAAY,GAAG,GAAG,SAAS,WAAW,CAAA;AAC5C,KAAK,MAAM,aAAa,IAAI,YAAE,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;IACxD,MAAM,mBAAmB,GACvB,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,KAAK,MAAM,CAAA;IACjG,IAAI,aAAa,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,EAAE;QACjE,SAAQ;KACT;IACD,MAAM,WAAW,GAAG,GAAG,YAAY,IAAI,aAAa,EAAE,CAAA;IACtD,IAAI,YAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE;QAC1C,8DAA8D;QAC9D,CAAC;QAAC,OAAO,CAAC,GAAG,WAAW,MAAM,CAAoB,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;KAC/F;CACF;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,KAAK,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAA;CACH"}

package/dist/commands/cloud-run/flare.d.ts

@@ -6,20 +6,24 @@ import { Command } from 'clipanion';
 import { CloudRunLog } from './interfaces';
 export declare const MAX_LOGS = 1000;
 export declare class CloudRunFlareCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
     private isDryRun;
     private withLogs;
-    private service?;
-    private project?;
-    private region?;
-    private caseId?;
-    private email?;
+    private service;
+    private project;
+    private region;
+    private caseId;
+    private email;
+    private start;
+    private end;
     private apiKey?;
     /**
      * Entry point for the `cloud-run flare` command.
      * Gathers Cloud Run service configuration and sends it to Datadog.
      * @returns 0 if the command ran successfully, 1 otherwise.
      */
-    execute(): Promise<1 | 0>;
+    execute(): Promise<0 | 1>;
 }
 /**
  * Check if the user is authenticated with GCP.
@@ -43,18 +47,45 @@ export declare const getCloudRunServiceConfig: (runClient: ServicesClient, servi
  * @returns masked config
  */
 export declare const maskConfig: (config: any) => IService;
+/**
+ * Summarizes the Cloud Run config as to not flood the terminal
+ * @param config
+ * @returns a summarized config
+ */
+export declare const summarizeConfig: (config: IService) => any;
 /**
  * Gets recent logs
  * @param logClient Logging client
  * @param serviceId
  * @param location
+ * @param startMillis start time in milliseconds or undefined if no start time is specified
+ * @param endMillis end time in milliseconds or undefined if no end time is specified
  * @param severityFilter if included, adds the string to the filter
  * @returns array of logs as CloudRunLog interfaces
  */
-export declare const getLogs: (logClient: Logging, serviceId: string, location: string, severityFilter?: string | undefined) => Promise<CloudRunLog[]>;
+export declare const getLogs: (logClient: Logging, serviceId: string, location: string, startMillis?: number, endMillis?: number, severityFilter?: string) => Promise<CloudRunLog[]>;
 /**
  * Save logs in a CSV format
  * @param logs array of logs stored as CloudRunLog interfaces
  * @param filePath path to save the CSV file
  */
 export declare const saveLogsFile: (logs: CloudRunLog[], filePath: string) => void;
+/**
+ * Gets recent revisions for a cloud-run service
+ * @param service
+ * @param location
+ * @param project
+ * @returns a string array of recent revisions and their deployment timestamp
+ */
+export declare const getRecentRevisions: (service: string, location: string, project: string) => Promise<string[]>;
+/**
+ * Generate the insights file
+ * @param insightsFilePath path to the insights file
+ * @param isDryRun whether or not this is a dry run
+ * @param config Cloud run service configuration
+ * @param service
+ * @param location
+ * @param project
+ * @param revisions a string array of recent revisions
+ */
+export declare const generateInsightsFile: (insightsFilePath: string, isDryRun: boolean, config: IService, service: string, location: string, project: string, revisions: string[]) => void;

package/dist/commands/cloud-run/flare.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -31,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveLogsFile = exports.getLogs = exports.maskConfig = exports.getCloudRunServiceConfig = exports.checkAuthentication = exports.CloudRunFlareCommand = exports.MAX_LOGS = void 0;
+exports.generateInsightsFile = exports.getRecentRevisions = exports.saveLogsFile = exports.getLogs = exports.summarizeConfig = exports.maskConfig = exports.getCloudRunServiceConfig = exports.checkAuthentication = exports.CloudRunFlareCommand = exports.MAX_LOGS = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const process_1 = __importDefault(require("process"));
@@ -46,15 +50,20 @@ const flare_1 = require("../../helpers/flare");
 const fs_2 = require("../../helpers/fs");
 const prompt_1 = require("../../helpers/prompt");
 const helpersRenderer = __importStar(require("../../helpers/renderer"));
+const renderer_1 = require("../../helpers/renderer");
 const utils_1 = require("../../helpers/utils");
+const version_1 = require("../../helpers/version");
+const flare_2 = require("../lambda/flare");
 const constants_2 = require("./constants");
-const renderer_1 = require("./renderer");
+const renderer_2 = require("./renderer");
 const SERVICE_CONFIG_FILE_NAME = 'service_config.json';
-const FLARE_ZIP_FILE_NAME = 'cloudrun-flare-output.zip';
+const FLARE_ZIP_FILE_NAME = 'cloud-run-flare-output.zip';
 const ALL_LOGS_FILE_NAME = 'all_logs.csv';
 const WARNING_LOGS_FILE_NAME = 'warning_logs.csv';
 const ERRORS_LOGS_FILE_NAME = 'error_logs.csv';
 const DEBUG_LOGS_FILE_NAME = 'debug_logs.csv';
+// What's the maximum number of revisions we want to include? Too many revisions will flood the INSIGHTS.md file
+const MAX_REVISIONS = 10;
 // Must be in range 0 - 1000. If more logs are needed, pagination must be implemented
 exports.MAX_LOGS = 1000;
 // How old the logs can be in minutes. Skip older logs
@@ -70,8 +79,15 @@ const LOG_CONFIGS = [
 class CloudRunFlareCommand extends clipanion_1.Command {
     constructor() {
         super(...arguments);
-        this.isDryRun = false;
-        this.withLogs = false;
+        this.isDryRun = clipanion_1.Option.Boolean('-d,--dry,--dry-run', false);
+        this.withLogs = clipanion_1.Option.Boolean('--with-logs', false);
+        this.service = clipanion_1.Option.String('-s,--service');
+        this.project = clipanion_1.Option.String('-p,--project');
+        this.region = clipanion_1.Option.String('-r,--region,-l,--location');
+        this.caseId = clipanion_1.Option.String('-c,--case-id');
+        this.email = clipanion_1.Option.String('-e,--email');
+        this.start = clipanion_1.Option.String('--start');
+        this.end = clipanion_1.Option.String('--end');
     }
     /**
      * Entry point for the `cloud-run flare` command.
@@ -108,6 +124,18 @@ class CloudRunFlareCommand extends clipanion_1.Command {
             if (this.email === undefined) {
                 errorMessages.push(helpersRenderer.renderError('No email specified. [-e,--email]'));
             }
+            // Validate start/end flags if both are specified
+            let startMillis;
+            let endMillis;
+            try {
+                ;
+                [startMillis, endMillis] = (0, flare_1.validateStartEndFlags)(this.start, this.end);
+            }
+            catch (err) {
+                if (err instanceof Error) {
+                    errorMessages.push(helpersRenderer.renderError(err.message));
+                }
+            }
             // If there are errors, print them and exit
             if (errorMessages.length > 0) {
                 for (const message of errorMessages) {
@@ -117,9 +145,9 @@ class CloudRunFlareCommand extends clipanion_1.Command {
             }
             // Verify GCP credentials
             this.context.stdout.write(chalk_1.default.bold('\n🔑 Verifying GCP credentials...\n'));
-            const authenticated = yield exports.checkAuthentication();
+            const authenticated = yield (0, exports.checkAuthentication)();
             if (!authenticated) {
-                this.context.stderr.write(renderer_1.renderAuthenticationInstructions());
+                this.context.stderr.write((0, renderer_2.renderAuthenticationInstructions)());
                 return 1;
             }
             this.context.stdout.write('GCP credentials verified!\n');
@@ -128,7 +156,7 @@ class CloudRunFlareCommand extends clipanion_1.Command {
             const runClient = new run_1.ServicesClient();
             let config;
             try {
-                config = yield exports.getCloudRunServiceConfig(runClient, this.service, this.project, this.region);
+                config = yield (0, exports.getCloudRunServiceConfig)(runClient, this.service, this.project, this.region);
             }
             catch (err) {
                 if (err instanceof Error) {
@@ -136,11 +164,69 @@ class CloudRunFlareCommand extends clipanion_1.Command {
                 }
                 return 1;
             }
-            config = exports.maskConfig(config);
+            config = (0, exports.maskConfig)(config);
+            const summarizedConfig = (0, exports.summarizeConfig)(config);
             // 10 is the depth when inspecting the config file. Cloud-run configs have high depth, so
             // we must raise the depth from the default depth of 2.
-            const configStr = util_1.default.inspect(config, false, 10, true);
-            this.context.stdout.write(`\n${configStr}\n`);
+            const summarizedConfigStr = util_1.default.inspect(summarizedConfig, false, 10, true);
+            this.context.stdout.write(`\n${summarizedConfigStr}\n`);
+            this.context.stdout.write(chalk_1.default.italic(`(This is a summary of the configuration. The full configuration will be saved in "${SERVICE_CONFIG_FILE_NAME}".)\n`));
+            // Get project files
+            this.context.stdout.write(chalk_1.default.bold('\n📁 Searching for project files in current directory...\n'));
+            const projectFilePaths = yield (0, flare_1.getProjectFiles)(constants_1.FLARE_PROJECT_FILES);
+            this.context.stdout.write((0, renderer_1.renderProjectFiles)(projectFilePaths));
+            // Additional files
+            this.context.stdout.write('\n');
+            const additionalFilePaths = new Set();
+            let confirmAdditionalFiles;
+            try {
+                confirmAdditionalFiles = yield (0, prompt_1.requestConfirmation)('Do you want to specify any additional files to flare?', false);
+            }
+            catch (err) {
+                if (err instanceof Error) {
+                    this.context.stderr.write(helpersRenderer.renderError(err.message));
+                }
+                return 1;
+            }
+            while (confirmAdditionalFiles) {
+                this.context.stdout.write('\n');
+                let filePath;
+                try {
+                    filePath = yield (0, prompt_1.requestFilePath)();
+                }
+                catch (err) {
+                    if (err instanceof Error) {
+                        this.context.stderr.write(helpersRenderer.renderError(err.message));
+                    }
+                    return 1;
+                }
+                if (filePath === '') {
+                    this.context.stdout.write((0, renderer_1.renderAdditionalFiles)(additionalFilePaths));
+                    break;
+                }
+                try {
+                    filePath = (0, flare_1.validateFilePath)(filePath, projectFilePaths, additionalFilePaths);
+                    additionalFilePaths.add(filePath);
+                    const fileName = path_1.default.basename(filePath);
+                    this.context.stdout.write(`• Added file '${fileName}'\n`);
+                }
+                catch (err) {
+                    if (err instanceof Error) {
+                        this.context.stderr.write(err.message);
+                    }
+                }
+            }
+            // Get recent revisions, which will be used to generate insights file
+            this.context.stdout.write(chalk_1.default.bold('\n🌧 Fetching recent revisions...\n'));
+            let revisions = [];
+            try {
+                revisions = yield (0, exports.getRecentRevisions)(this.service, this.region, this.project);
+                this.context.stdout.write(`• Found ${revisions.length} revisions\n`);
+            }
+            catch (err) {
+                const errorDetails = err instanceof Error ? err.message : '';
+                this.context.stdout.write(helpersRenderer.renderSoftWarning(`Unable to fetch recent revisions. ${errorDetails}`));
+            }
             // Get logs
             const logFileMappings = new Map();
             if (this.withLogs) {
@@ -148,7 +234,7 @@ class CloudRunFlareCommand extends clipanion_1.Command {
                 const logClient = new logging_1.Logging({ projectId: this.project });
                 for (const logConfig of LOG_CONFIGS) {
                     try {
-                        const logs = yield exports.getLogs(logClient, this.service, this.region, logConfig.severityFilter);
+                        const logs = yield (0, exports.getLogs)(logClient, this.service, this.region, startMillis, endMillis, logConfig.severityFilter);
                         if (logs.length === 0) {
                             this.context.stdout.write(`• No ${logConfig.type} logs were found\n`);
                         }
@@ -167,35 +253,68 @@ class CloudRunFlareCommand extends clipanion_1.Command {
                 // Create folders
                 const rootFolderPath = path_1.default.join(process_1.default.cwd(), constants_1.FLARE_OUTPUT_DIRECTORY);
                 const logsFolderPath = path_1.default.join(rootFolderPath, constants_1.LOGS_DIRECTORY);
+                const projectFilesFolderPath = path_1.default.join(rootFolderPath, constants_1.PROJECT_FILES_DIRECTORY);
+                const additionalFilesFolderPath = path_1.default.join(rootFolderPath, constants_1.ADDITIONAL_FILES_DIRECTORY);
                 this.context.stdout.write(chalk_1.default.bold(`\n💾 Saving files to ${rootFolderPath}...\n`));
                 if (fs_1.default.existsSync(rootFolderPath)) {
-                    fs_2.deleteFolder(rootFolderPath);
+                    (0, fs_2.deleteFolder)(rootFolderPath);
                 }
                 const subFolders = [];
                 if (logFileMappings.size > 0) {
                     subFolders.push(logsFolderPath);
                 }
-                fs_2.createDirectories(rootFolderPath, subFolders);
+                if (projectFilePaths.size > 0) {
+                    subFolders.push(projectFilesFolderPath);
+                }
+                if (additionalFilePaths.size > 0) {
+                    subFolders.push(additionalFilesFolderPath);
+                }
+                (0, fs_2.createDirectories)(rootFolderPath, subFolders);
                 // Write config file
                 const configFilePath = path_1.default.join(rootFolderPath, SERVICE_CONFIG_FILE_NAME);
-                fs_2.writeFile(configFilePath, JSON.stringify(config, undefined, 2));
+                (0, fs_2.writeFile)(configFilePath, JSON.stringify(config, undefined, 2));
                 this.context.stdout.write(`• Saved function config to ./${SERVICE_CONFIG_FILE_NAME}\n`);
                 // Write logs
                 for (const [fileName, logs] of logFileMappings) {
                     const logFilePath = path_1.default.join(logsFolderPath, fileName);
-                    exports.saveLogsFile(logs, logFilePath);
+                    (0, exports.saveLogsFile)(logs, logFilePath);
                     this.context.stdout.write(`• Saved logs to ./${constants_1.LOGS_DIRECTORY}/${fileName}\n`);
                 }
+                // Write project files
+                for (const filePath of projectFilePaths) {
+                    const fileName = path_1.default.basename(filePath);
+                    const newFilePath = path_1.default.join(projectFilesFolderPath, fileName);
+                    fs_1.default.copyFileSync(filePath, newFilePath);
+                    this.context.stdout.write(`• Copied ${fileName} to ./${constants_1.PROJECT_FILES_DIRECTORY}/${fileName}\n`);
+                }
+                // Write additional files
+                const additionalFilesMap = (0, flare_2.getUniqueFileNames)(additionalFilePaths);
+                for (const [originalFilePath, newFileName] of additionalFilesMap) {
+                    const originalFileName = path_1.default.basename(originalFilePath);
+                    const newFilePath = path_1.default.join(additionalFilesFolderPath, newFileName);
+                    fs_1.default.copyFileSync(originalFilePath, newFilePath);
+                    this.context.stdout.write(`• Copied ${originalFileName} to ./${constants_1.ADDITIONAL_FILES_DIRECTORY}/${newFileName}\n`);
+                }
+                // Write insights file
+                try {
+                    const insightsFilePath = path_1.default.join(rootFolderPath, constants_1.INSIGHTS_FILE_NAME);
+                    (0, exports.generateInsightsFile)(insightsFilePath, this.isDryRun, config, this.service, this.region, this.project, revisions);
+                    this.context.stdout.write(`• Saved insights file to ./${constants_1.INSIGHTS_FILE_NAME}\n`);
+                }
+                catch (err) {
+                    const errorDetails = err instanceof Error ? err.message : '';
+                    this.context.stdout.write(helpersRenderer.renderSoftWarning(`Unable to create INSIGHTS.md file. ${errorDetails}`));
+                }
                 // Exit if dry run
                 const outputMsg = `\nℹ️ Your output files are located at: ${rootFolderPath}\n\n`;
                 if (this.isDryRun) {
-                    this.context.stdout.write('\n🚫 The flare files were not sent as it was executed in dry run mode.');
+                    this.context.stdout.write('\n🚫 The flare files were not sent because the command was executed in dry run mode.');
                     this.context.stdout.write(outputMsg);
                     return 0;
                 }
                 // Confirm before sending
                 this.context.stdout.write('\n');
-                const confirmSendFiles = yield prompt_1.requestConfirmation('Are you sure you want to send the flare file to Datadog Support?', false);
+                const confirmSendFiles = yield (0, prompt_1.requestConfirmation)('Are you sure you want to send the flare file to Datadog Support?', false);
                 if (!confirmSendFiles) {
                     this.context.stdout.write('\n🚫 The flare files were not sent based on your selection.');
                     this.context.stdout.write(outputMsg);
@@ -203,13 +322,13 @@ class CloudRunFlareCommand extends clipanion_1.Command {
                 }
                 // Zip folder
                 const zipPath = path_1.default.join(rootFolderPath, FLARE_ZIP_FILE_NAME);
-                yield fs_2.zipContents(rootFolderPath, zipPath);
+                yield (0, fs_2.zipContents)(rootFolderPath, zipPath);
                 // Send to Datadog
                 this.context.stdout.write(chalk_1.default.bold('\n🚀 Sending to Datadog Support...\n'));
-                yield flare_1.sendToDatadog(zipPath, this.caseId, this.email, this.apiKey, rootFolderPath);
+                yield (0, flare_1.sendToDatadog)(zipPath, this.caseId, this.email, this.apiKey, rootFolderPath);
                 this.context.stdout.write(chalk_1.default.bold('\n✅ Successfully sent flare file to Datadog Support!\n'));
                 // Delete contents
-                fs_2.deleteFolder(rootFolderPath);
+                (0, fs_2.deleteFolder)(rootFolderPath);
             }
             catch (err) {
                 if (err instanceof Error) {
@@ -222,6 +341,11 @@ class CloudRunFlareCommand extends clipanion_1.Command {
     }
 }
 exports.CloudRunFlareCommand = CloudRunFlareCommand;
+CloudRunFlareCommand.paths = [['cloud-run', 'flare']];
+CloudRunFlareCommand.usage = clipanion_1.Command.Usage({
+    category: 'Serverless',
+    description: 'Gather Cloud Run service configuration and sends it to Datadog.',
+});
 /**
  * Check if the user is authenticated with GCP.
  * @returns true if the user is authenticated, false otherwise
@@ -277,32 +401,66 @@ const maskConfig = (config) => {
                 continue;
             }
             if (!constants_2.SKIP_MASKING_CLOUDRUN_ENV_VARS.has(name)) {
-                envVar.value = utils_1.maskString(val);
+                envVar.value = (0, utils_1.maskString)(val);
             }
         }
     }
     return configCopy;
 };
 exports.maskConfig = maskConfig;
+/**
+ * Summarizes the Cloud Run config as to not flood the terminal
+ * @param config
+ * @returns a summarized config
+ */
+const summarizeConfig = (config) => {
+    var _a;
+    const summarizedConfig = {};
+    summarizedConfig.name = config.name;
+    summarizedConfig.uid = config.uid;
+    summarizedConfig.uri = config.uri;
+    // Get env vars and image for each containers
+    const template = config.template;
+    if (template) {
+        const summarizedContainers = [];
+        const containers = (_a = template.containers) !== null && _a !== void 0 ? _a : [];
+        containers.forEach((container) => {
+            const summarizedContainer = {};
+            summarizedContainer.env = container.env;
+            summarizedContainer.image = container.image;
+            summarizedContainers.push(summarizedContainer);
+        });
+        summarizedConfig.containers = summarizedContainers;
+    }
+    return summarizedConfig;
+};
+exports.summarizeConfig = summarizeConfig;
 /**
  * Gets recent logs
  * @param logClient Logging client
  * @param serviceId
  * @param location
+ * @param startMillis start time in milliseconds or undefined if no start time is specified
+ * @param endMillis end time in milliseconds or undefined if no end time is specified
  * @param severityFilter if included, adds the string to the filter
  * @returns array of logs as CloudRunLog interfaces
  */
-const getLogs = (logClient, serviceId, location, severityFilter) => __awaiter(void 0, void 0, void 0, function* () {
+const getLogs = (logClient, serviceId, location, startMillis, endMillis, severityFilter) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     const logs = [];
-    // Only get recent logs
+    // Default to the recent logs using MAX_LOG_AGE_MINUTES
     const date = new Date();
     date.setMinutes(date.getMinutes() - MAX_LOG_AGE_MINUTES);
-    const formattedDate = date.toISOString();
+    let startDate = date.toISOString();
+    let endDate = new Date().toISOString(); // Current time
+    // If startMillis and endMillis are provided, use them to set the date range
+    if (startMillis && endMillis) {
+        startDate = new Date(startMillis).toISOString();
+        endDate = new Date(endMillis).toISOString();
+    }
     // Query options
-    let filter = `resource.labels.service_name="${serviceId}" AND resource.labels.location="${location}" AND timestamp>="${formattedDate}" AND (textPayload:* OR httpRequest:*)`;
-    // We only want to get logs from the last `MAX_LOG_AGE_MINUTES` to make sure they are relevant.
-    // We also only want to include logs with a textPayload or logs that were an HTTP request.
+    let filter = `resource.labels.service_name="${serviceId}" AND resource.labels.location="${location}" AND timestamp>="${startDate}" AND timestamp<="${endDate}" AND (textPayload:* OR httpRequest:*)`;
+    // We only want to include logs with a textPayload or logs that were an HTTP request.
     // Any other logs are just audit logs which are spammy and don't have any relevant information.
     filter += severityFilter !== null && severityFilter !== void 0 ? severityFilter : '';
     const options = {
@@ -324,7 +482,7 @@ const getLogs = (logClient, serviceId, location, severityFilter) => __awaiter(vo
             if (latency) {
                 ms = (Number(latency.seconds) * 1000 + Math.round(Number(latency.nanos) / 1000000)).toString();
             }
-            const bytes = utils_1.formatBytes(Number(request.responseSize));
+            const bytes = (0, utils_1.formatBytes)(Number(request.responseSize));
             const method = (_b = request.requestMethod) !== null && _b !== void 0 ? _b : '';
             const requestUrl = (_c = request.requestUrl) !== null && _c !== void 0 ? _c : '';
             msg += `${method} ${status}. responseSize: ${bytes}. latency: ${ms} ms. requestUrl: ${requestUrl}`;
@@ -355,15 +513,122 @@ const saveLogsFile = (logs, filePath) => {
         rows.push([severity, timestamp, logName, logMessage]);
     });
     const data = rows.join('\n');
-    fs_2.writeFile(filePath, data);
+    (0, fs_2.writeFile)(filePath, data);
 };
 exports.saveLogsFile = saveLogsFile;
-CloudRunFlareCommand.addPath('cloud-run', 'flare');
-CloudRunFlareCommand.addOption('isDryRun', clipanion_1.Command.Boolean('-d,--dry'));
-CloudRunFlareCommand.addOption('withLogs', clipanion_1.Command.Boolean('--with-logs'));
-CloudRunFlareCommand.addOption('service', clipanion_1.Command.String('-s,--service'));
-CloudRunFlareCommand.addOption('project', clipanion_1.Command.String('-p,--project'));
-CloudRunFlareCommand.addOption('region', clipanion_1.Command.String('-r,--region,-l,--location'));
-CloudRunFlareCommand.addOption('caseId', clipanion_1.Command.String('-c,--case-id'));
-CloudRunFlareCommand.addOption('email', clipanion_1.Command.String('-e,--email'));
+/**
+ * Gets recent revisions for a cloud-run service
+ * @param service
+ * @param location
+ * @param project
+ * @returns a string array of recent revisions and their deployment timestamp
+ */
+const getRecentRevisions = (service, location, project) => __awaiter(void 0, void 0, void 0, function* () {
+    var _j;
+    const client = new run_1.RevisionsClient();
+    const request = {
+        parent: client.servicePath(project, location, service),
+    };
+    // listRevisions() returns a tuple [Revision[], Request, Response],
+    // so we index the first element to get the array of revisions
+    const revisions = (yield client.listRevisions(request))[0];
+    const revisionTimestampStrings = [];
+    let counter = 1;
+    for (const entry of revisions) {
+        const fullName = entry.name;
+        const timestamp = entry.createTime;
+        if (fullName && timestamp) {
+            // Get the revision name
+            const nameSplit = fullName.split('/');
+            const revisionName = nameSplit[nameSplit.length - 1];
+            // Format the timestamp by first converting seconds/nanos to milliseconds, then using `new Date()`
+            const milliseconds = Number((_j = timestamp.seconds) !== null && _j !== void 0 ? _j : 0) * 1000;
+            const timestampString = new Date(milliseconds).toISOString().replace('T', ' ').replace('Z', '').slice(0, -4); // Chop off the milliseconds, which will always be .000
+            revisionTimestampStrings.push(`\`${revisionName}\` Deployed on ${timestampString}`);
+        }
+        // Stop iterating once we reach MAX_REVISIONS
+        counter += 1;
+        if (counter > MAX_REVISIONS) {
+            break;
+        }
+    }
+    return revisionTimestampStrings;
+});
+exports.getRecentRevisions = getRecentRevisions;
+/**
+ * Generate the insights file
+ * @param insightsFilePath path to the insights file
+ * @param isDryRun whether or not this is a dry run
+ * @param config Cloud run service configuration
+ * @param service
+ * @param location
+ * @param project
+ * @param revisions a string array of recent revisions
+ */
+const generateInsightsFile = (insightsFilePath, isDryRun, config, service, location, project, revisions) => {
+    var _a, _b, _c, _d, _e, _f;
+    const lines = [];
+    // Header
+    lines.push('# Flare Insights');
+    lines.push('\n_Autogenerated file from `cloud-run flare`_  ');
+    if (isDryRun) {
+        lines.push('_This command was run in dry mode._');
+    }
+    // Cloud Run Service Configuration
+    lines.push('\n## Cloud Run Service Configuration');
+    lines.push(`**Service Name**: \`${service}\`  `);
+    lines.push(`**Location**: \`${location}\`  `);
+    lines.push(`**Project**: \`${project}\`  `);
+    const description = config.description;
+    if (description && description.length > 0) {
+        lines.push(`**Description**: \`${description}\`  `);
+    }
+    lines.push(`**URI**: \`${(_a = config.uri) !== null && _a !== void 0 ? _a : ''}\``);
+    // Environment variables
+    const containers = (_c = (_b = config.template) === null || _b === void 0 ? void 0 : _b.containers) !== null && _c !== void 0 ? _c : [];
+    for (const container of containers) {
+        // We want to separate environment variables by container if there are multiple containers
+        // We can use the container image to uniquely identify each container
+        lines.push(`\n**Environment Variables** (${(_d = container.image) !== null && _d !== void 0 ? _d : 'unknown image'}):`);
+        const envVars = new Map();
+        for (const envVar of (_e = container.env) !== null && _e !== void 0 ? _e : []) {
+            const name = envVar.name;
+            const value = envVar.value;
+            if (name && value) {
+                envVars.set(name, value);
+            }
+        }
+        if (envVars.size === 0) {
+            lines.push('- No environment variables found.');
+        }
+        for (const [key, value] of envVars) {
+            lines.push(`- \`${key}\`: \`${value}\``);
+        }
+    }
+    // Labels
+    lines.push('\n**Labels**:');
+    const labels = (_f = config.labels) !== null && _f !== void 0 ? _f : {};
+    const entries = Object.entries(labels);
+    if (entries.length === 0) {
+        lines.push('- No labels found.');
+    }
+    for (const [key, value] of entries) {
+        lines.push(`- \`${key}\`: \`${value}\``);
+    }
+    // Recent revisions
+    if (revisions.length > 0) {
+        lines.push('\n**Recent Revisions**:');
+        for (const revision of revisions) {
+            lines.push(`- ${revision}`);
+        }
+    }
+    // CLI Insights
+    lines.push('\n ## CLI');
+    lines.push(`**Run Location**: \`${process_1.default.cwd()}\`  `);
+    lines.push(`**CLI Version**: \`${version_1.version}\`  `);
+    const timeString = new Date().toISOString().replace('T', ' ').replace('Z', '') + ' UTC';
+    lines.push(`**Timestamp**: \`${timeString}\`  `);
+    (0, fs_2.writeFile)(insightsFilePath, lines.join('\n'));
+};
+exports.generateInsightsFile = generateInsightsFile;
 //# sourceMappingURL=flare.js.map