@middy/cloudwatch-metrics 7.2.2 → 7.3.0

package/index.d.ts

@@ -8,6 +8,7 @@ export { MetricsLogger } from "aws-embedded-metrics";
 export interface Options {
 	namespace?: string;
 	dimensions?: Array<Record<string, string>>;
+	onFlushError?: (error: Error) => void;
 }
 
 export type Context = LambdaContext & {
@@ -18,4 +19,8 @@ declare function cloudwatchMetrics(
 	options?: Options,
 ): middy.MiddlewareObj<unknown, unknown, Error>;
 
+export declare function cloudwatchMetricsValidateOptions(
+	options?: Record<string, unknown>,
+): void;
+
 export default cloudwatchMetrics;

package/index.js

@@ -1,11 +1,24 @@
 // Copyright 2017 - 2026 will Farrell, Luciano Mammino, and Middy contributors.
 // SPDX-License-Identifier: MIT
+
+import { validateOptions } from "@middy/util";
 import awsEmbeddedMetrics from "aws-embedded-metrics";
 
-const defaults = {};
+const defaults = {
+	onFlushError: undefined,
+};
+
+const optionSchema = {
+	namespace: "string?",
+	dimensions: "array?",
+	onFlushError: "function?",
+};
+
+export const cloudwatchMetricsValidateOptions = (options) =>
+	validateOptions("@middy/cloudwatch-metrics", optionSchema, options);
 
 const cloudwatchMetricsMiddleware = (opts = {}) => {
-	const { namespace, dimensions } = { ...defaults, ...opts };
+	const { namespace, dimensions, onFlushError } = { ...defaults, ...opts };
 	const cloudwatchMetricsBefore = async (request) => {
 		const metrics = awsEmbeddedMetrics.createMetricsLogger();
 
@@ -21,12 +34,18 @@ const cloudwatchMetricsMiddleware = (opts = {}) => {
 		Object.assign(request.context, { metrics });
 	};
 
-	const cloudwatchMetricsAfter = async (request) => {
-		await request.context.metrics?.flush();
-	};
-	const cloudwatchMetricsOnError = async (request) => {
-		await request.context.metrics?.flush();
+	const flushMetrics = async (request) => {
+		try {
+			await request.context.metrics?.flush();
+		} catch (err) {
+			// Flush errors are swallowed to prevent metrics from crashing the
+			// handler. Users who need visibility (e.g., to catch IAM or network
+			// misconfigurations) can pass `onFlushError` to observe them.
+			onFlushError?.(err);
+		}
 	};
+	const cloudwatchMetricsAfter = flushMetrics;
+	const cloudwatchMetricsOnError = flushMetrics;
 
 	return {
 		before: cloudwatchMetricsBefore,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@middy/cloudwatch-metrics",
-	"version": "7.2.2",
+	"version": "7.3.0",
 	"description": "Embedded CloudWatch metrics middleware for the middy framework",
 	"type": "module",
 	"engines": {
@@ -17,9 +17,6 @@
 			"import": {
 				"types": "./index.d.ts",
 				"default": "./index.js"
-			},
-			"require": {
-				"default": "./index.js"
 			}
 		}
 	},
@@ -71,7 +68,7 @@
 		"aws-embedded-metrics": "4.2.1"
 	},
 	"devDependencies": {
-		"@middy/core": "7.2.2",
+		"@middy/core": "7.3.0",
 		"@types/aws-lambda": "^8.0.0",
 		"@types/node": "^22.0.0"
 	}