@aws-lambda-powertools/metrics/lib/cjs/middleware/middy.d.ts

The metrics package for the Powertools for AWS Lambda (TypeScript) library

import type { MiddlewareLikeObj } from '@aws-lambda-powertools/commons/types';
import type { Metrics } from '../Metrics.js';
import type { ExtraOptions } from '../types/Metrics.js';
/**
 * A Middy.js middleware automating capture of Amazon CloudWatch metrics.
 *
 * This middleware is compatible with `@middy/core@3.x` and above.
 *
 * The middleware automatically flushes metrics after the handler function returns or throws an error,
 * so you don't need to call {@link Metrics.publishStoredMetrics | `publishStoredMetrics()`} manually.
 *
 * @example
 * ```typescript
 * import { Metrics, MetricUnit } from '@aws-lambda-powertools/metrics';
 * import { logMetrics } from '@aws-lambda-powertools/metrics/middleware';
 * import middy from '@middy/core';
 *
 * const metrics = new Metrics({
 *   namespace: 'serverlessAirline',
 *   serviceName: 'orders'
 * });
 *
 * export const handler = middy(async () => {
 *   metrics.addMetadata('request_id', event.requestId);
 *   metrics.addMetric('successfulBooking', MetricUnit.Count, 1);
 * }).use(logMetrics(metrics, {
 *   captureColdStartMetric: true,
 *   throwOnEmptyMetrics: true,
 * }));
 * ```
 *
 * You can configure the middleware with the following options:
 * - `captureColdStartMetric`: Whether to capture a `ColdStart` metric
 * - `defaultDimensions`: Default dimensions to add to all metrics
 * - `throwOnEmptyMetrics`: Whether to throw an error if no metrics are emitted
 *
 * @param target - The Metrics instance to use for emitting metrics
 * @param options - Options to configure the middleware, see {@link ExtraOptions}
 */
declare const logMetrics: (target: Metrics | Metrics[], options?: ExtraOptions) => MiddlewareLikeObj;
export { logMetrics };
//# sourceMappingURL=middy.d.ts.map