-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(lambda): cloudwatch lambda insights (#15439)
Closes #12489 This allows a user to configure Lambda Insights and have the relevant IAM policy be added to the Lambda role. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
1 parent
6244a81
commit 9efd800
Showing
14 changed files
with
1,349 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| import { Aws, CfnMapping, Fn, IResolveContext, Lazy, Stack, Token } from '@aws-cdk/core'; | ||
| import { FactName, RegionInfo } from '@aws-cdk/region-info'; | ||
| import { CLOUDWATCH_LAMBDA_INSIGHTS_ARNS } from '@aws-cdk/region-info/build-tools/fact-tables'; | ||
|
|
||
| // This is the name of the mapping that will be added to the CloudFormation template, if a stack is region agnostic | ||
| const DEFAULT_MAPPING_PREFIX = 'LambdaInsightsVersions'; | ||
|
|
||
| // To add new versions, update fact-tables.ts `CLOUDWATCH_LAMBDA_INSIGHTS_ARNS` and create a new `public static readonly VERSION_A_B_C_D` | ||
|
|
||
| /** | ||
| * Version of CloudWatch Lambda Insights | ||
| */ | ||
| export abstract class LambdaInsightsVersion { | ||
|
|
||
| /** | ||
| * Version 1.0.54.0 | ||
| */ | ||
| public static readonly VERSION_1_0_54_0 = LambdaInsightsVersion.fromInsightsVersion('1.0.54.0'); | ||
|
|
||
| /** | ||
| * Version 1.0.86.0 | ||
| */ | ||
| public static readonly VERSION_1_0_86_0 = LambdaInsightsVersion.fromInsightsVersion('1.0.86.0'); | ||
|
|
||
| /** | ||
| * Version 1.0.89.0 | ||
| */ | ||
| public static readonly VERSION_1_0_89_0 = LambdaInsightsVersion.fromInsightsVersion('1.0.89.0'); | ||
|
|
||
| /** | ||
| * Version 1.0.98.0 | ||
| */ | ||
| public static readonly VERSION_1_0_98_0 = LambdaInsightsVersion.fromInsightsVersion('1.0.98.0'); | ||
|
|
||
| /** | ||
| * Use the insights extension associated with the provided ARN. Make sure the ARN is associated | ||
| * with same region as your function | ||
| * | ||
| * @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html | ||
| */ | ||
| public static fromInsightVersionArn(arn: string): LambdaInsightsVersion { | ||
| class InsightsArn extends LambdaInsightsVersion { | ||
| public readonly layerVersionArn = arn; | ||
| } | ||
| return new InsightsArn(); | ||
| } | ||
|
|
||
| // Use the verison to build the object. Not meant to be called by the user -- user should use e.g. VERSION_1_0_54_0 | ||
| private static fromInsightsVersion(insightsVersion: string): LambdaInsightsVersion { | ||
|
|
||
| // Check if insights version is valid. This should only happen if one of the public static readonly versions are set incorrectly | ||
| if (!(insightsVersion in CLOUDWATCH_LAMBDA_INSIGHTS_ARNS)) { | ||
| throw new Error(`Insights version ${insightsVersion} does not exist. Available versions are ${CLOUDWATCH_LAMBDA_INSIGHTS_ARNS.keys()}`); | ||
| } | ||
|
|
||
| class InsightsVersion extends LambdaInsightsVersion { | ||
| public readonly layerVersionArn = Lazy.uncachedString({ | ||
| produce: (context) => getVersionArn(context, insightsVersion), | ||
| }); | ||
| } | ||
| return new InsightsVersion(); | ||
| } | ||
|
|
||
| /** | ||
| * The arn of the Lambda Insights extension | ||
| */ | ||
| public readonly layerVersionArn: string = ''; | ||
| } | ||
|
|
||
| /** | ||
| * Function to retrieve the correct Lambda Insights ARN from RegionInfo, | ||
| * or create a mapping to look it up at stack deployment time. | ||
| * | ||
| * This function is run on CDK synthesis. | ||
| */ | ||
| function getVersionArn(context: IResolveContext, insightsVersion: string): string { | ||
|
|
||
| const scopeStack = Stack.of(context.scope); | ||
| const region = scopeStack.region; | ||
|
|
||
| // Region is defined, look up the arn, or throw an error if the version isn't supported by a region | ||
| if (region !== undefined && !Token.isUnresolved(region)) { | ||
| const arn = RegionInfo.get(region).cloudwatchLambdaInsightsArn(insightsVersion); | ||
| if (arn === undefined) { | ||
| throw new Error(`Insights version ${insightsVersion} is not supported in region ${region}`); | ||
| } | ||
| return arn; | ||
| } | ||
|
|
||
| // Otherwise, need to add a mapping to be looked up at deployment time | ||
|
|
||
| /** | ||
| * See this for the context as to why the mappings are the way they are | ||
| * https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html | ||
| * | ||
| * Mappings have to have a structure like this, and no functions can be used inside them: | ||
| * <Alphanumeric only> | ||
| * - <Can be non-alphanumeric> | ||
| * -- { <alphanumeric>: "value1"}, | ||
| * -- { <alphanumeric>: "value2"} | ||
| * | ||
| * So we cannot have an otherwise ideal mapping like this, because '1.0.98.0' is non-alphanumeric: | ||
| * LambdaInsightsVersions | ||
| * - us-east-1 | ||
| * -- {'1.0.98.0': 'arn1'}, | ||
| * -- {'1.0.89.0': 'arn2'} | ||
| * | ||
| * To get around this limitation, this is the mapping structure: | ||
| * LambdaInsightsVersions10980 // for version 1.0.98.0 | ||
| * - us-east-1 | ||
| * -- {'arn': 'arn1'}, | ||
| * - us-east-2 | ||
| * -- {'arn': 'arn2'} | ||
| * LambdaInsightsVersions10890 // a separate mapping version 1.0.89.0 | ||
| * - us-east-1 | ||
| * -- {'arn': 'arn3'}, | ||
| * - us-east-2 | ||
| * -- {'arn': 'arn4'} | ||
| */ | ||
|
|
||
| const mapName = DEFAULT_MAPPING_PREFIX + insightsVersion.split('.').join(''); | ||
| const mapping: { [k1: string]: { [k2: string]: any } } = {}; | ||
| const region2arns = RegionInfo.regionMap(FactName.cloudwatchLambdaInsightsVersion(insightsVersion)); | ||
| for (const [reg, arn] of Object.entries(region2arns)) { | ||
| mapping[reg] = { arn }; | ||
| } | ||
|
|
||
| // Only create a given mapping once. If another version of insights is used elsewhere, that mapping will also exist | ||
| if (!scopeStack.node.tryFindChild(mapName)) { | ||
| new CfnMapping(scopeStack, mapName, { mapping }); | ||
| } | ||
| // The ARN will be looked up at deployment time from the mapping we created | ||
| return Fn.findInMap(mapName, Aws.REGION, 'arn'); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.