@datadog/datadog-ci 2.16.1 → 2.17.0

package/dist/commands/lambda/flare.d.ts

@@ -0,0 +1,127 @@
+import { CloudWatchLogsClient, OutputLogEvent } from '@aws-sdk/client-cloudwatch-logs';
+import { FunctionConfiguration, LambdaClient } from '@aws-sdk/client-lambda';
+import { Command } from 'clipanion';
+export declare class LambdaFlareCommand extends Command {
+    private isDryRun;
+    private withLogs;
+    private functionName?;
+    private region?;
+    private apiKey?;
+    private caseId?;
+    private email?;
+    private start?;
+    private end?;
+    private credentials?;
+    /**
+     * Entry point for the `lambda flare` command.
+     * Gathers lambda function configuration and sends it to Datadog.
+     * @returns 0 if the command ran successfully, 1 otherwise.
+     */
+    execute(): Promise<1 | 0>;
+}
+/**
+ * Validate the start and end flags and adds error messages if found
+ * @param start start time as a string
+ * @param end end time as a string
+ * @throws error if start or end are not valid numbers
+ * @returns [startMillis, endMillis] as numbers or [undefined, undefined] if both are undefined
+ */
+export declare const validateStartEndFlags: (start: string | undefined, end: string | undefined) => number[] | undefined[];
+/**
+ * Mask the environment variables in a Lambda function configuration
+ * @param config
+ */
+export declare const maskConfig: (config: FunctionConfiguration) => FunctionConfiguration;
+/**
+ * Delete a folder and all its contents
+ * @param folderPath the folder to delete
+ * @throws Error if the deletion fails
+ */
+export declare const deleteFolder: (folderPath: string) => void;
+/**
+ * Creates the root folder and the logs sub-folder
+ * @param rootFolderPath path to the root folder
+ * @param logsFolderPath path to the logs folder
+ * @param logs array of logs
+ * @throws Error if the root folder cannot be deleted or folders cannot be created
+ */
+export declare const createDirectories: (rootFolderPath: string, logsFolderPath: string, logs: Map<string, OutputLogEvent[]>) => void;
+/**
+ * Gets the LOG_STREAM_COUNT latest log stream names, sorted by last event time
+ * @param cwlClient CloudWatch Logs client
+ * @param logGroupName name of the log group
+ * @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
+ * @returns an array of the last LOG_STREAM_COUNT log stream names or an empty array if no log streams are found
+ * @throws Error if the log streams cannot be retrieved
+ */
+export declare const getLogStreamNames: (cwlClient: CloudWatchLogsClient, logGroupName: string, startMillis: number | undefined, endMillis: number | undefined) => Promise<string[]>;
+/**
+ * Gets the log events for a log stream
+ * @param cwlClient
+ * @param logGroupName
+ * @param logStreamName
+ * @param startMillis
+ * @param endMillis
+ * @returns the log events or an empty array if no log events are found
+ * @throws Error if the log events cannot be retrieved
+ */
+export declare const getLogEvents: (cwlClient: CloudWatchLogsClient, logGroupName: string, logStreamName: string, startMillis: number | undefined, endMillis: number | undefined) => Promise<OutputLogEvent[]>;
+/**
+ * Gets all CloudWatch logs for a function
+ * @param region
+ * @param functionName
+ * @param startMillis start time in milliseconds or undefined if no end time is specified
+ * @param endMillis end time in milliseconds or undefined if no end time is specified
+ * @returns a map of log stream names to log events or an empty map if no logs are found
+ */
+export declare const getAllLogs: (region: string, functionName: string, startMillis: number | undefined, endMillis: number | undefined) => Promise<Map<string, OutputLogEvent[]>>;
+/**
+ * Gets the tags for a function
+ * @param lambdaClient
+ * @param region
+ * @param arn
+ * @returns the tags or an empty object if no tags are found
+ * @throws Error if the tags cannot be retrieved
+ */
+export declare const getTags: (lambdaClient: LambdaClient, region: string, arn: string) => Promise<Record<string, string>>;
+/**
+ * Write the function config to a file
+ * @param filePath path to the file
+ * @param data the data to write
+ * @throws Error if the file cannot be written
+ */
+export declare const writeFile: (filePath: string, data: string) => void;
+/**
+ * Convert the log events to a CSV string
+ * @param logEvents array of log events
+ * @returns the CSV string
+ */
+export declare const convertToCSV: (logEvents: OutputLogEvent[]) => string;
+/**
+ * @param ms number of milliseconds to sleep
+ */
+export declare const sleep: (ms: number) => Promise<void>;
+/**
+ * Zip the contents of the flare folder
+ * @param rootFolderPath path to the root folder to zip
+ * @param zipPath path to save the zip file
+ * @throws Error if the zip fails
+ */
+export declare const zipContents: (rootFolderPath: string, zipPath: string) => Promise<void>;
+/**
+ * Calculates the full endpoint URL
+ * @throws Error if the site is invalid
+ * @returns the full endpoint URL
+ */
+export declare const getEndpointUrl: () => string;
+/**
+ * Send the zip file to Datadog support
+ * @param zipPath
+ * @param caseId
+ * @param email
+ * @param apiKey
+ * @param rootFolderPath
+ * @throws Error if the request fails
+ */
+export declare const sendToDatadog: (zipPath: string, caseId: string, email: string, apiKey: string, rootFolderPath: string) => Promise<void>;