momentohq · anitarua · Nov 6, 2023 · Sep 18, 2023 · Oct 4, 2023 · Oct 6, 2023
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/README.md b/examples/nodejs/lambda-examples/cloudwatch-metrics/README.md
@@ -0,0 +1,119 @@
+<head>
+  <meta name="Momento Node.js Client Library Documentation" content="Node.js client software development kit for Momento Cache">
+</head>
+<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>
+
+[![project status](https://momentohq.github.io/standards-and-practices/badges/project-status-official.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)
+[![project stability](https://momentohq.github.io/standards-and-practices/badges/project-stability-stable.svg)](https://github.com/momentohq/standards-and-practices/blob/main/docs/momento-on-github.md)
+
+<br>
+
+## CloudWatch Metrics using Momento's Experimental Metrics Middleware
+
+This directory contains an AWS CDK stack that will create and populate a custom CloudWatch dashboard for Momento client-side metrics. You can deploy an example Lambda function or ECS cluster that uses the Momento Node.js SDK's Experimental Metrics Middleware to generate example dashboard data for 5 minutes at a time. Or you can deploy just the CloudWatch dashboard and use your own application to emit Momento metrics.
+
+## Prerequisites
+
+- Node version 18 or higher is required
+- To get started with Momento, you will need a Super User Momento API key. You can get one from the [Momento Console](https://console.gomomento.com). Check out the [getting started](https://docs.momentohq.com/getting-started) guide for more information on obtaining an API key.
+- To deploy the CDK app, you will need to have [configured your AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html#cli-chap-authentication-precedence).
+
+## Deploying the CloudWatch Dashboard (along with an example Momento Lambda Function)
+
+Follow the instructions in this section to deploy a CloudWatch dashboard along with a Node.js Lambda function that uses Momento's Experimental Metrics Middleware.
+
+First make sure to start Docker and install the dependencies in the `lambda` directory, which is where the Lambda code lives.
+
+```bash
+cd lambda
+npm install
+```
+
+The source code for the CDK application lives in the `infrastructure` directory.
+To build and deploy it you will first need to install the dependencies:
+
+```bash
+cd infrastructure
+npm install
+```
+
+Then create a `.env` file in the `infrastructure` directory, which is where you will define all required configuration variables. 
+You will need the Super User API key you generated from the [Momento Console](https://console.gomomento.com). You will also set the `EXAMPLE_MOMENTO_APPLICATION` variable to `lambda` like so:
+
+```bash
+MOMENTO_API_KEY=<YOUR_MOMENTO_API_KEY>
+EXAMPLE_MOMENTO_APPLICATION="lambda"
+```
+
+Then deploy the CDK stack for the example Lambda function and CloudWatch dashboard:
+
+```
+npm run cdk -- deploy
+```
+
+To run the lambda, go to the `MomentoMetricsMiddlewareCDKExample` function in the AWS Lambda console and click the `test` button to invoke the example.
+
+After a few minutes, you should be able to see the metrics populating several charts by navigating to CloudWatch > Dashboards > Custom Dashboards > MomentoMetricsCDKExampleDashboard in the AWS console.
+
+## Deploying the CloudWatch Dashboard (along with an example Momento ECS Cluster)
+
+Follow the instructions in this section to deploy a CloudWatch dashboard along with a small ECS cluster for a Node.js Docker image that uses Momento's Experimental Metrics Middleware.
+
+First make sure to start Docker and install the dependencies in the `docker` directory, which is where the ECS container code lives.
+
+```bash
+cd docker
+npm install
+```
+
+The source code for the CDK application lives in the `infrastructure` directory.
+To build and deploy it you will first need to install the dependencies:
+
+```bash
+cd infrastructure
+npm install
+```
+
+Then create a `.env` file in the `infrastructure` directory, which is where you will define all required configuration variables. 
+You will need the Super User API key you generated from the [Momento Console](https://console.gomomento.com). You will also set the `EXAMPLE_MOMENTO_APPLICATION` variable to `ecs` like so:
+
+```bash
+MOMENTO_API_KEY=<YOUR_MOMENTO_API_KEY>
+EXAMPLE_MOMENTO_APPLICATION="ecs"
+```
+
+Then deploy the CDK stack for the example Lambda function and CloudWatch dashboard:
+
+```
+npm run cdk -- deploy
+```
+
+The ECS cluster should automatically start running the task and generating logs. After a few minutes, you should be able to see the metrics populating several charts by navigating to CloudWatch > Dashboards > Custom Dashboards > MomentoMetricsCDKExampleDashboard in the AWS console.
+
+## Deploying only the CloudWatch Dashboard
+
+Follow the instructions in this section to deploy only the CloudWatch metric filters and dashboard. This configuration option assumes you have an existing application that uses the Node.js or .NET Momento SDK Experimental Metrics Middleware that will emit metrics to the log group created by this CDK stack.
+
+First make sure to start Docker and install the dependencies in the `infrastructure` directory.
+
+```bash
+cd infrastructure
+npm install
+```
+
+Then create a `.env` file in the `infrastructure` directory, which is where you will define all required configuration variables. 
+You will need the Super User API key you generated from the [Momento Console](https://console.gomomento.com). You will also set the `EXAMPLE_MOMENTO_APPLICATION` and `LOG_GROUP_NAME` variables like so:
+
+```bash
+MOMENTO_API_KEY=<YOUR_MOMENTO_API_KEY>
+EXAMPLE_MOMENTO_APPLICATION="dashboard-only"
+LOG_GROUP_NAME="<YOUR_LOG_GROUP_NAME>"
+```
+
+Deploy the CDK stack for the metric filters and CloudWatch dashboard:
+
+```
+npm run cdk -- deploy
+```
+
+And then finally deploy your existing application in the usual way. Please note that this setup assumes your application will emit logs to the log group created for the dashboard, so be sure to double check that the log group names are aligned.
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/Dockerfile b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/Dockerfile
@@ -0,0 +1,11 @@
+FROM --platform=linux/amd64 public.ecr.aws/docker/library/node:latest
+
+WORKDIR /usr/src/app
+
+COPY ecs-code/index.ts ./
+COPY ecs-code/package.json ./
+RUN npm install
+
+ENV MOMENTO_API_KEY_SECRET_NAME="MomentoMetricsApiKey"
+CMD ["npm", "run", "start"]
+
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.eslintignore b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.eslintignore
@@ -0,0 +1,3 @@
+node_modules
+dist
+**/*.d.ts
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.eslintrc.json b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.eslintrc.json
@@ -0,0 +1,62 @@
+{
+  "root": true,
+  "env": {
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:import/recommended",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "project": "./tsconfig.json"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "semi": ["error", "always"],
+    "import/no-extraneous-dependencies": ["error", {}],
+    "node/no-unsupported-features/es-syntax": "off",
+    "node/no-missing-import": [
+      "error",
+      {
+        "tryExtensions": [".js", ".ts", ".json", ".node"]
+      }
+    ],
+    "prettier/prettier": "error",
+    "block-scoped-var": "error",
+    "eqeqeq": "error",
+    "no-var": "error",
+    "prefer-const": "error",
+    "eol-last": "error",
+    "prefer-arrow-callback": "error",
+    "no-trailing-spaces": "error",
+    "quotes": ["warn", "single", {"avoidEscape": true}],
+    "no-restricted-properties": [
+      "error",
+      {
+        "object": "describe",
+        "property": "only"
+      },
+      {
+        "object": "it",
+        "property": "only"
+      }
+    ],
+    // async without await is often an error and in other uses it obfuscates
+    // the intent of the developer. Functions are async when they want to await.
+    "require-await": "error",
+    "import/no-duplicates": "error"
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".jsx", ".ts", ".tsx"]
+      }
+    }
+  }
+}
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.gitignore b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.gitignore
@@ -0,0 +1 @@
+advanced-middlewares-example-metrics.csv
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.npmignore b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.npmignore
@@ -0,0 +1,2 @@
+*.ts
+!*.d.ts
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.prettierrc.json b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/.prettierrc.json
@@ -0,0 +1,8 @@
+{
+    "bracketSpacing": false,
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "arrowParens": "avoid",
+    "printWidth": 120
+  }
+
diff --git a/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/index.ts b/examples/nodejs/lambda-examples/cloudwatch-metrics/docker/ecs-code/index.ts
@@ -0,0 +1,73 @@
+import {GetSecretValueCommand, SecretsManagerClient} from '@aws-sdk/client-secrets-manager';
+import {
+  CacheClient,
+  Configurations,
+  DefaultMomentoLoggerFactory,
+  DefaultMomentoLoggerLevel,
+  CredentialProvider,
+} from '@gomomento/sdk';
+import {ExperimentalMetricsLoggingMiddleware} from '@gomomento/sdk/dist/src/config/middleware/experimental-metrics-logging-middleware';
+
+const _secretsClient = new SecretsManagerClient({});
+const _cachedSecrets = new Map<string, string>();
+let _cacheClient: CacheClient | undefined = undefined;
+
+async function main() {
+  try {
+    const loggerFactory = new DefaultMomentoLoggerFactory(DefaultMomentoLoggerLevel.INFO);
+    const logger = loggerFactory.getLogger('CloudWatchMetricsMiddlewaresExample');
+
+    const cacheClient = await getCacheClient(loggerFactory);
+    logger.info('Created a CacheClient configured with metrics middleware');
+
+    logger.info('Issuing 5 minutes of set and get requests to generate data for the dashboard example');
+    for (let i = 0; i < 60 /* seconds */ * 5 /* minutes */; i++) {
+      await cacheClient.set('cache', 'metrics-example-{i}', 'VALUE');
+      await cacheClient.get('cache', 'metrics-example-{i}');
+      await delay(1000);
+    }
+
+    logger.info('Momento metrics middleware example complete!');
+  } catch (err) {
+    console.log('Error occurred in the ECS example code:', err);
+  }
+}
+
+async function getCacheClient(loggerFactory: DefaultMomentoLoggerFactory): Promise<CacheClient> {
+  const apiKeySecretName = process.env.MOMENTO_API_KEY_SECRET_NAME;
+  if (apiKeySecretName === undefined) {
+    throw new Error("Missing required env var 'MOMENTO_API_KEY_SECRET_NAME");
+  }
+  if (_cacheClient === undefined) {
+    const momentoApiKey = await getSecret(apiKeySecretName);
+
+    _cacheClient = await CacheClient.create({
+      configuration: Configurations.Lambda.latest(loggerFactory).withMiddlewares([
+        new ExperimentalMetricsLoggingMiddleware(loggerFactory),
+      ]),
+      credentialProvider: CredentialProvider.fromString({apiKey: momentoApiKey}),
+      defaultTtlSeconds: 60,
+    });
+  }
+  return _cacheClient;
+}
+
+async function getSecret(secretName: string): Promise<string> {
+  if (!_cachedSecrets.has(secretName)) {
+    const secretResponse = await _secretsClient.send(new GetSecretValueCommand({SecretId: secretName}));
+    if (secretResponse) {
+      _cachedSecrets.set(secretName, secretResponse.SecretString!);
+    } else {
+      throw new Error(`Unable to retrieve secret: ${secretName}`);
+    }
+  }
+  return _cachedSecrets.get(secretName)!;
+}
+
+function delay(ms: number): Promise<unknown> {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+main().catch(err => {
+  console.log('Error in example run:', err);
+});