Merge pull request #16 from aws-samples/saestag

Hoseong-Seo · web-flow · commit d9a12f930f78 · 2024-08-15T00:51:26.000+09:00
SAES Metrics tags
diff --git a/server/lib/bootstrap-template/control-plane-stack.ts b/server/lib/bootstrap-template/control-plane-stack.ts
@@ -5,6 +5,7 @@ import path = require('path');
 import { StaticSite } from './static-site';
 import { ControlPlaneNag } from '../cdknag/control-plane-nag';
 import * as sbt from '@cdklabs/sbt-aws';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface ControlPlaneStackProps extends cdk.StackProps {
   systemAdminRoleName: string
@@ -20,7 +21,7 @@ export class ControlPlaneStack extends cdk.Stack {
 
   constructor (scope: Construct, id: string, props: ControlPlaneStackProps) {
     super(scope, id, props);
-
+    addTemplateTag(this, 'ControlPlaneStack');
     const accessLogsBucket = new cdk.aws_s3.Bucket(this, 'AccessLogsBucket', {
       enforceSSL: true,
       autoDeleteObjects: true,
diff --git a/server/lib/bootstrap-template/core-appplane-stack.ts b/server/lib/bootstrap-template/core-appplane-stack.ts
@@ -7,6 +7,7 @@ import * as fs from 'fs';
 import { UserInterface } from './user-interface';
 import { CoreAppPlaneNag } from '../cdknag/core-app-plane-nag';
 import * as sbt from '@cdklabs/sbt-aws';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface CoreAppPlaneStackProps extends cdk.StackProps {
   eventManager: sbt.IEventManager
@@ -19,6 +20,7 @@ export class CoreAppPlaneStack extends cdk.Stack {
   public readonly tenantMappingTable: Table;
   constructor (scope: Construct, id: string, props: CoreAppPlaneStackProps) {
     super(scope, id, props);
+    addTemplateTag(this, 'CoreAppPlaneStack');
 
     const systemAdminEmail = props.systemAdminEmail;
 
diff --git a/server/lib/bootstrap-template/static-site-distro.ts b/server/lib/bootstrap-template/static-site-distro.ts
@@ -4,6 +4,7 @@ import * as iam from 'aws-cdk-lib/aws-iam';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import { Construct } from 'constructs';
 import { RemovalPolicy } from 'aws-cdk-lib';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface StaticSiteDistroProps {
   readonly allowedMethods: string[]
@@ -16,6 +17,7 @@ export class StaticSiteDistro extends Construct {
 
   constructor (scope: Construct, id: string, props: StaticSiteDistroProps) {
     super(scope, id);
+    addTemplateTag(this, 'StaticSiteDistro');
     const { distribution, appBucket } = this.createStaticSite(
       id,
       props.allowedMethods,
diff --git a/server/lib/bootstrap-template/static-site.ts b/server/lib/bootstrap-template/static-site.ts
@@ -8,6 +8,7 @@ import * as s3 from 'aws-cdk-lib/aws-s3';
 import * as kms from 'aws-cdk-lib/aws-kms';
 import { Construct } from 'constructs';
 import { RemovalPolicy } from 'aws-cdk-lib';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface StaticSiteProps {
   readonly name: string
@@ -28,7 +29,7 @@ export class StaticSite extends Construct {
 
   constructor (scope: Construct, id: string, props: StaticSiteProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'StaticSite');
     const defaultBranchName = props.defaultBranchName ?? 'main';
     const repository = new codecommit.Repository(this, `${id}Repository`, {
       repositoryName: props.name,
diff --git a/server/lib/shared-infra/api-gateway.ts b/server/lib/shared-infra/api-gateway.ts
@@ -9,6 +9,7 @@ import { type CustomApiKey } from '../interfaces/custom-api-key';
 import { LogGroup } from 'aws-cdk-lib/aws-logs';
 import { Construct } from 'constructs';
 import { Duration } from 'aws-cdk-lib';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface ApiGatewayProps {
   lambdaEcsSaaSLayers: lambda.LayerVersion
@@ -28,7 +29,7 @@ export class ApiGateway extends Construct {
   public readonly requestValidator: apigateway.RequestValidator;
   constructor (scope: Construct, id: string, props: ApiGatewayProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'ApiGateway');
     // 👇Create ACM Permission Policy
     const basicAuthorizerExecutionRole = new cdk.aws_iam.PolicyDocument({
       statements: [
diff --git a/server/lib/shared-infra/api-methods.ts b/server/lib/shared-infra/api-methods.ts
@@ -2,6 +2,7 @@ import type * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';
 import { type ApiGateway } from './api-gateway';
 import * as apigateway from 'aws-cdk-lib/aws-apigateway';
 import { Construct } from 'constructs';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface ApiMethodsProps {
   serviceName: string
@@ -13,7 +14,7 @@ export interface ApiMethodsProps {
 export class ApiMethods extends Construct {
   constructor (scope: Construct, id: string, props: ApiMethodsProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'ApiMethods');
     const integration = new apigateway.Integration({
       type: apigateway.IntegrationType.HTTP_PROXY,
       uri: `http://${props.nlb.loadBalancerDnsName}/${props.serviceName}`,
diff --git a/server/lib/shared-infra/shared-infra-stack.ts b/server/lib/shared-infra/shared-infra-stack.ts
@@ -15,6 +15,7 @@ import { SharedInfraNag } from '../cdknag/shared-infra-nag';
 import { ApiGateway } from './api-gateway';
 import { type ApiKeySSMParameterNames } from '../interfaces/api-key-ssm-parameter-names';
 import { TenantApiKey } from './tenant-api-key';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface SharedInfraProps extends cdk.StackProps {
   isPooledDeploy: boolean
@@ -39,7 +40,7 @@ export class SharedInfraStack extends cdk.Stack {
 
   constructor (scope: Construct, id: string, props: SharedInfraProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'SharedInfraStack');
     const azs = cdk.Fn.getAzs(this.region);
     // 스택의 리전에 있는 모든 가용 영역 목록 가져오기
 
diff --git a/server/lib/shared-infra/tenant-api-key.ts b/server/lib/shared-infra/tenant-api-key.ts
@@ -1,6 +1,7 @@
 import { Construct } from 'constructs';
 import { ApiKey } from 'aws-cdk-lib/aws-apigateway';
 import { StringParameter } from 'aws-cdk-lib/aws-ssm';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface TenantApiKeyProps {
   apiKeyValue: string
@@ -13,6 +14,7 @@ export class TenantApiKey extends Construct {
   apiKeyValue: string;
   constructor (scope: Construct, id: string, props: TenantApiKeyProps) {
     super(scope, id);
+    addTemplateTag(this, 'TenantApiKey');
     this.apiKeyValue = props.apiKeyValue;
 
     this.apiKey = new ApiKey(this, 'apiKey', {
diff --git a/server/lib/shared-infra/usage-plans.ts b/server/lib/shared-infra/usage-plans.ts
@@ -1,5 +1,6 @@
 import { Construct } from 'constructs';
 import { ApiKey, Period, type RestApi, type UsagePlan } from 'aws-cdk-lib/aws-apigateway';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface UsagePlansProps {
   apiGateway: RestApi
@@ -18,7 +19,7 @@ export class UsagePlans extends Construct {
   public readonly usagePlanSystemAdmin: UsagePlan;
   constructor (scope: Construct, id: string, props: UsagePlansProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'UsagePlans');
     this.usagePlanBasicTier = props.apiGateway.addUsagePlan('UsagePlanBasicTier', {
       quota: {
         limit: 1000,
diff --git a/server/lib/tenant-template/ecs-cluster.ts b/server/lib/tenant-template/ecs-cluster.ts
@@ -14,6 +14,7 @@ import getTimeString, { getHashCode } from '../utilities/helper-functions';
 import { type ContainerInfo } from '../interfaces/container-info';
 import { type RproxyInfo } from '../interfaces/rproxy-info';
 import { CustomEniTrunking } from './eni-trunking';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface EcsClusterProps extends cdk.NestedStackProps {
   stageName: string
@@ -39,7 +40,7 @@ export class EcsCluster extends cdk.NestedStack {
 
   constructor (scope: Construct, id: string, props: EcsClusterProps) {
     super(scope, id, props);
-
+    addTemplateTag(this, 'EcsClusterStack');
     const tenantId = props.tenantId;
     const timeStr = getTimeString();
     this.isEc2Tier = props.isEc2Tier;
diff --git a/server/lib/tenant-template/eni-trunking.ts b/server/lib/tenant-template/eni-trunking.ts
@@ -3,13 +3,14 @@ import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as iam from 'aws-cdk-lib/aws-iam';
 import { Runtime } from 'aws-cdk-lib/aws-lambda';
 import { Construct } from 'constructs';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export class CustomEniTrunking extends Construct {
   public readonly ec2Role: iam.Role;
 
   constructor(scope: Construct, id: string, props?: cdk.NestedStackProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'EniTrunking');
     // Lambda function code
     const lambdaFunctionCode = lambda.Code.fromInline(`
       const { ECSClient, PutAccountSettingCommand } = require("@aws-sdk/client-ecs");
diff --git a/server/lib/tenant-template/identity-provider.ts b/server/lib/tenant-template/identity-provider.ts
@@ -1,6 +1,7 @@
 import { aws_cognito, type StackProps } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import { type IdentityDetails } from '../interfaces/identity-details';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface IdentityProviderStackProps extends StackProps {
   tenantId: string
@@ -13,7 +14,7 @@ export class IdentityProvider extends Construct {
   public readonly identityDetails: IdentityDetails;
   constructor (scope: Construct, id: string, props: IdentityProviderStackProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'IdentityProvider');
     this.tenantUserPool = new aws_cognito.UserPool(this, 'TenantUserPool', {
       autoVerify: { email: true },
       selfSignUpEnabled: true,
diff --git a/server/lib/tenant-template/tenant-template-stack.ts b/server/lib/tenant-template/tenant-template-stack.ts
@@ -10,6 +10,7 @@ import {
 } from 'aws-cdk-lib/custom-resources';
 import { EcsCluster } from './ecs-cluster';
 import { TenantInfraNag } from '../cdknag/tenant-infra-nag';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface TenantTemplateStackProps extends cdk.StackProps {
   stageName: string
@@ -33,6 +34,7 @@ export class TenantTemplateStack extends cdk.Stack {
   constructor (scope: Construct, id: string, props: TenantTemplateStackProps) {
     super(scope, id, props);
     const waveNumber = props.waveNumber || '1';
+    addTemplateTag(this, 'TenantTemplateStack');
 
     const identityProvider = new IdentityProvider(this, 'IdentityProvider', {
       tenantId: props.tenantId,
diff --git a/server/lib/tenant-template/tenant-update-stack.ts b/server/lib/tenant-template/tenant-update-stack.ts
@@ -9,6 +9,7 @@ import { type Table } from 'aws-cdk-lib/aws-dynamodb';
 import { ECSSaaSPipelineNag } from '../cdknag/ecs-saas-pipeline-nag';
 import { type Construct } from 'constructs';
 import { RemovalPolicy } from 'aws-cdk-lib';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 export interface TenantUpdatePipelineProps extends cdk.StackProps {
   tenantMappingTable: Table
@@ -18,6 +19,7 @@ export interface TenantUpdatePipelineProps extends cdk.StackProps {
 export class TenantUpdatePipeline extends cdk.Stack {
   constructor (scope: Construct, id: string, props: TenantUpdatePipelineProps) {
     super(scope, id, props);
+    addTemplateTag(this, 'TenantUpdatePipeline');
 
     const accessLogsBucket = new cdk.aws_s3.Bucket(this, 'AccessLogsBucket', {
       enforceSSL: true,
diff --git a/server/lib/tenant-template/usage-plans.ts b/server/lib/tenant-template/usage-plans.ts
@@ -1,5 +1,6 @@
 import { Construct } from 'constructs';
 import { ApiKey, Period, type RestApi, type UsagePlan } from 'aws-cdk-lib/aws-apigateway';
+import { addTemplateTag } from '../utilities/helper-functions';
 
 interface UsagePlansProps {
   apiGateway: RestApi
@@ -18,7 +19,7 @@ export class UsagePlans extends Construct {
   public readonly usagePlanSystemAdmin: UsagePlan;
   constructor (scope: Construct, id: string, props: UsagePlansProps) {
     super(scope, id);
-
+    addTemplateTag(this, 'UsagePlans');
     this.usagePlanBasicTier = props.apiGateway.addUsagePlan('UsagePlanBasicTier', {
       quota: {
         limit: 1000,
diff --git a/server/lib/utilities/helper-functions.ts b/server/lib/utilities/helper-functions.ts
@@ -1,3 +1,6 @@
+import { Stack } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+
 export const getEnv = (varName: string) => {
   const val = process.env[varName];
   if (!val) {
@@ -30,3 +33,46 @@ const pad = (n: number, l: number) => {
 };
 
 export default getTimeString;
+
+export const addTemplateTag = (construct: Construct, tag: string) => {
+  const stackDesc = Stack.of(construct).templateOptions.description;
+  const baseTelemetry = 'saas-reference-architecture-ecs (uksb-bwv1p0slbs)';
+  let description = stackDesc;
+  // There is no description, just make it telemetry + tags
+  if (stackDesc === undefined) {
+    description = appendTagToDescription(baseTelemetry, tag);
+  }
+  // There is a description, and it doesn't contain telemetry. We need to append telemetry + tags to it
+  else if (!stackDesc.includes(baseTelemetry)) {
+    description = appendTagToDescription(`${stackDesc} - ${baseTelemetry}`, tag);
+  }
+  // There is a telemetry description already
+  else {
+    description = appendTagToDescription(stackDesc, tag);
+  }
+  Stack.of(construct).templateOptions.description = description;
+};
+
+const appendTagToDescription = (existingDescription: string, newTag: string): string => {
+  // Check if the existing description already has tags
+  if (existingDescription.includes('(tag:')) {
+    // Extract the existing tags
+    const startIndex = existingDescription.indexOf('(tag:') + 6;
+    const endIndex = existingDescription.lastIndexOf(')');
+    const existingTags = existingDescription.substring(startIndex, endIndex).split(', ');
+
+    // Check if the new tag already exists
+    if (!existingTags.includes(newTag)) {
+      // Append the new tag to the existing tags
+      existingTags.push(newTag);
+      const newDescription = `${existingDescription.substring(0, startIndex)}${existingTags.join(', ')})`;
+      return newDescription;
+    } else {
+      // The new tag already exists, return the original description
+      return existingDescription;
+    }
+  } else {
+    // Append the new tag to the description
+    return `${existingDescription} (tag: ${newTag})`;
+  }
+};
