@aws-amplify/core 4.4.0 → 4.4.1-cloud-logging.7

package/src/Providers/AmazonKinesisLoggingProvider.ts

@@ -0,0 +1,43 @@
+import { AmazonKinesisLoggerOptions, LoggingProvider } from '../types/types';
+import { ConsoleLogger as Logger } from '../Logger';
+import {
+	AMAZON_KINESIS_LOGGING_PROVIDER_NAME,
+	AMAZON_KINESIS_LOGGING_CATEGORY,
+	NO_CREDS_ERROR_STRING,
+	RETRY_ERROR_CODES,
+} from '../Util/Constants';
+
+const logger = new Logger('AmazonKinesisLoggingProvider');
+
+export class AmazonKinesisLoggingProvider implements LoggingProvider {
+	static readonly PROVIDER_NAME = AMAZON_KINESIS_LOGGING_PROVIDER_NAME;
+	static readonly CATEGORY = AMAZON_KINESIS_LOGGING_CATEGORY;
+
+	private _config: AmazonKinesisLoggerOptions;
+
+	constructor(config?: AmazonKinesisLoggerOptions) {}
+
+	public getProviderName(): string {
+		return AmazonKinesisLoggingProvider.PROVIDER_NAME;
+	}
+
+	public getCategoryName(): string {
+		return AmazonKinesisLoggingProvider.CATEGORY;
+	}
+
+	public configure(
+		config?: AmazonKinesisLoggerOptions
+	): AmazonKinesisLoggerOptions {
+		if (!config) return this._config || {};
+
+		return this._config;
+	}
+
+	public pushLogs(logs: any[]): void {
+		logger.debug('pushing log events to Kinesis...');
+	}
+
+	public pause() {}
+
+	public resume() {}
+}

package/src/Util/Constants.ts

@@ -12,11 +12,16 @@
  */
 
 // Logging constants
+// Cloudwatch
 const AWS_CLOUDWATCH_BASE_BUFFER_SIZE = 26;
 const AWS_CLOUDWATCH_MAX_BATCH_EVENT_SIZE = 1048576;
 const AWS_CLOUDWATCH_MAX_EVENT_SIZE = 256000;
 const AWS_CLOUDWATCH_CATEGORY = 'Logging';
 const AWS_CLOUDWATCH_PROVIDER_NAME = 'AWSCloudWatch';
+
+const AMAZON_KINESIS_LOGGING_CATEGORY = 'KinesisLogging';
+const AMAZON_KINESIS_LOGGING_PROVIDER_NAME = 'AmazonKinesisLogging';
+
 const NO_CREDS_ERROR_STRING = 'No credentials';
 const RETRY_ERROR_CODES = [
 	'ResourceNotFoundException',
@@ -31,4 +36,6 @@ export {
 	AWS_CLOUDWATCH_PROVIDER_NAME,
 	NO_CREDS_ERROR_STRING,
 	RETRY_ERROR_CODES,
+	AMAZON_KINESIS_LOGGING_PROVIDER_NAME,
+	AMAZON_KINESIS_LOGGING_CATEGORY,
 };

package/src/Util/Retry.ts

@@ -28,9 +28,8 @@ export async function retry(
 		throw Error('functionToRetry must be a function');
 	}
 	logger.debug(
-		`${
-			functionToRetry.name
-		} attempt #${attempt} with this vars: ${JSON.stringify(args)}`
+		`${functionToRetry.name} attempt #${attempt} with this vars:`,
+		args
 	);
 
 	try {

package/src/types/types.ts

@@ -1,62 +1,79 @@
-import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
-import { Credentials } from '@aws-sdk/types';
-
-export interface AmplifyConfig {
-	Analytics?: object;
-	Auth?: object;
-	API?: object;
-	Logging?: object;
-	Storage?: object;
-	Cache?: object;
-	Geo?: object;
-	ssr?: boolean;
-}
-
-export interface ICredentials {
-	accessKeyId: string;
-	sessionToken: string;
-	secretAccessKey: string;
-	identityId: string;
-	authenticated: boolean;
-	// Long term creds do not provide an expiration date
-	expiration?: Date;
-}
-
-/**
- * @private
- * Internal use of Amplify only
- */
-
-export type DelayFunction = (
-	attempt: number,
-	args?: any[],
-	error?: Error
-) => number | false;
-
-export interface LoggingProvider {
-	// return the name of you provider
-	getProviderName(): string;
-
-	// return the name of you category
-	getCategoryName(): string;
-
-	// configure the plugin
-	configure(config?: object): object;
-
-	// take logs and push to provider
-	pushLogs(logs: InputLogEvent[]): void;
-}
-
-export interface AWSCloudWatchProviderOptions {
-	logGroupName?: string;
-	logStreamName?: string;
-	region?: string;
-	credentials?: Credentials;
-	endpoint?: string;
-}
-
-export interface CloudWatchDataTracker {
-	eventUploadInProgress: boolean;
-	logEvents: InputLogEvent[];
-	verifiedLogGroup?: LogGroup;
-}
+import { InputLogEvent, LogGroup } from '@aws-sdk/client-cloudwatch-logs';
+import { Credentials } from '@aws-sdk/types';
+
+export interface AmplifyConfig {
+	Analytics?: object;
+	Auth?: object;
+	API?: object;
+	Logging?: object;
+	Storage?: object;
+	Cache?: object;
+	Geo?: object;
+	ssr?: boolean;
+}
+
+export interface ICredentials {
+	accessKeyId: string;
+	sessionToken: string;
+	secretAccessKey: string;
+	identityId: string;
+	authenticated: boolean;
+	// Long term creds do not provide an expiration date
+	expiration?: Date;
+}
+
+/**
+ * @private
+ * Internal use of Amplify only
+ */
+
+export type DelayFunction = (
+	attempt: number,
+	args?: any[],
+	error?: Error
+) => number | false;
+
+export interface LoggingProvider {
+	// return the name of you provider
+	getProviderName(): string;
+
+	// return the name of you category
+	getCategoryName(): string;
+
+	// configure the plugin
+	configure(config?: object): object;
+
+	// take logs and push to provider
+	pushLogs(logs: InputLogEvent[]): void;
+
+	// pause sending logs
+	pause(): void;
+	resume(): void;
+}
+
+export interface AWSCloudWatchProviderOptions {
+	logGroupName?: string;
+	logStreamName?: string;
+	region?: string;
+	credentials?: Credentials;
+	endpoint?: string;
+}
+
+export interface AmplifyConfigure {
+	Logging: {
+		logGroupName: string;
+		logStreamName: string;
+	};
+}
+
+export interface CloudWatchDataTracker {
+	eventUploadInProgress: boolean;
+	logEvents: InputLogEvent[];
+	verifiedLogGroup?: LogGroup;
+}
+
+export interface AmazonKinesisLoggerOptions {
+	region?: string;
+	credentials?: Credentials;
+	endpoint?: string;
+}