cat-a-logs 2.0.2 → 2.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Open Source Labs Beta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -28,26 +28,147 @@ Your chosen Integated Development Environment (i.e. VS Code) must already be be
       function catalog(
         trackedVariable: number | Array<number>,
         metricName: string,
-        metricNamespace: string,
+        metricNamespace: string = "CatALog-Default-Metrics",
         metricUnitLabel: string = "None",
         CustomerDefinedDimension: { [key: string]: string } = {},
         resolution: 1 | 60 = 60,
         deploy: boolean = false)
       ```
 
-    - **trackedVariable**: This variable represents a number that is dynamic and can change with each call - these numbers are reflected under Metrics
-    - **metricName**: This is a unique label of the tracked variable that will be reflected inside AWS Lambda. Must be written as a `string`
-    - **metricNamespace**: This will be your metric namespace in AWS Cloudwatch the metric or metrics will appear in
-    - **metricUnitLabel**: Explict Unit that Cloudwatch uses for EMF Configuration. Please note - Can only be the following labels:
-      - Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
+    - **trackedVariable**: This variable represents a the numerical value of the metric that will appear under the category "Custom namespace" in Cloudwatch Metrics. Custom metric category/namespace/AWS Namespace. This is AWS Cloudwatch>Metrics>All metrics>Custom namespaces(ex. CatALog)>Dimensions(ex. Server, functionVersion)
 
-      - To read more about Metric Datum see this <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html" target="_blank">link</a>
-    - **CustomerDefinedDimension**: This is an object - key will be demension and value 
-    - **resolution**: automatically set to default value
-    - **deploy**: automatically set to false 
+    <p align="center">
+    <img src="./snapshots/trackedVariable.png" width="600" />
+    </p>
+
+
+    - **metricName**: This is a unique label of the tracked variable that will be reflected inside AWS Cloudwatch. Must be written as a `string` 
+      In the below image this corresponds to `Latency` --> AWS Cloudwatch>Metrics>All metrics>Custom namespaces
 
+    <p align="center">
+    <img src="./snapshots/metricName.png" width="600"/>
+    </p>
 
+    - **metricNamespace**: This will be your "Custom namespace" in AWS Cloudwatch>Metrics>All metrics>Custom namespaces. In below image this is represented by CatALog
 
+    <p align="center">
+    <img src="./snapshots/customNameSpace.png" width="600"/>
+    </p>
+
+    - **metricUnitLabel**: Explict Unit that Cloudwatch uses for EMF Configuration. Please note - must be one of the following as a `string`:
+      - Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
+
+      - To read more about Metric Datum see this <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html" target="_blank">link</a>
+    - **CustomerDefinedDimension**: This is an object - `{'functionVersion': '$LATEST', 'Server': 'Prod'}` functionVersion & Server is the dimension label/key - when you click on it see the value `$LATEST` and `Prod` is the value of the dimension
+
+        - The key will show up in AWS Cloudwatch as below:
+
+          <p align="center">
+          <img src="./snapshots/keyDefined.png" width="600"/>
+          </p>
+
+        - If the user clicks on the Server, functionVersion Dimension then you will see the value - in this example `$LATEST` & `Prod` reflected as below:
+
+          <p align="center">
+          <img src="./snapshots/metricName.png" width="600"/>
+          </p>
+
+
+    - **resolution**: This is automatically set to default value to 60. If you would like to learn more about High Resolution Metrics please follow the attached <a href= "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics" target="_blank">link</a>
+    - **deploy**: automatically set to false. The final catalog call you make has to switch deploy flag to true. Failure to do so will cause the cache to grow without bound and use up memory
+
+3. Start Building your Embedded Metric Formatted Logs. Call catalog as many times as needed. 
+<!-- You can also `console.log(cache)` at any time to see your EMF formatted logs being built in real time.  -->
+
+4. ON the very last function call - it is important to change the deploy parameter to `true`. 
+
+5. Deploy your code with AWS SAM. This will place the file in AWS Lambda waiting for invokation.
+
+6. Invoke your AWS Lamda Function
+
+7. See your metrics and structured in CloudWatch! 
+
+## Open Source Contributions:
+We are actively looking for contributors to our project! In order to get started we ask that you follow the below guidelines:
+
+  - Clone our Repository from GitHub <a href="https://github.com/oslabs-beta/cat-a-log" target="_blank">here</a> 
+  - Make a Feature Branch 
+  - Make your contributions
+  - Push to your Feature Branch in GitHub
+  - Make a Pull Request to our Repository!
+
+
+| AWS MicroService Support                                                              | Status    |
+|---------------------------------------------------------------------------------------|-----------|
+| Lamda                                                                                 | ✅        |
+| EC2                                                                                   | ⏳        |
+
+
+
+|Feature                                                                                |Status     |
+|---------------------------------------------------------------------------------------|-----------|
+| TypeScript                                                                            | ✅        |
+| Embedded Metric Format Object Caching                                                 | ✅        |
+| Winson                                                                                | ⏳        |
+| Adding front end for Cat-A-Log                                                        | 🙏🏻        |
+
+
+- ✅ = Ready to use
+- ⏳ = In progress
+- 🙏🏻 = Looking for contributors
+
+## License Information:
+Put License Information Here
+
+
+## Contributor Information:
+ <table>
+  <tr>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/161962009?v=4" width="140px;" alt=""/>
+      <br />
+      <sub><b>Clara Regula</b></sub>
+      <br />
+      <a href="http://www.linkedin.com/in/clara-regula">🖇️</a>
+      <a href="https://github.com/clararegula">🐙</a>
+    </td>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/170294267?v=4" width="140px;" alt=""/>
+      <br />
+      <sub><b>Brian Anderson</b></sub>
+      <br />
+      <a href="https://www.linkedin.com/in/brian-anderson-24370630/">🖇️</a>
+      <a href="https://github.com/brianmichaelanderson">🐙</a>
+    </td>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/167483334?v=4" width="140px;" alt=""/>
+      <br />
+      <sub><b>Harris Awan</b></sub>
+      <br />
+      <a href="http://www.linkedin.com/in/harrawan123/">🖇️</a>
+      <a href="https://github.com/HarrAwa">🐙</a>
+    </td>
+     <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/26197909?v=4" width="140px;" alt=""/>
+      <br />
+      <sub><b>Curran Lee</b></sub>
+      <br />
+      <a href="https://www.linkedin.com/search/results/all/?fetchDeterministicClustersOnly=false&heroEntityKey=urn%3Ali%3Afsd_profile%3AACoAABxBUMYBYh3jl6z8XMVs4D1VjdqU-oastdc&keywords=natalie%20klein&origin=RICH_QUERY_SUGGESTION&position=0&searchId=7ca29d7e-56b5-4dce-a2a1-f9d9e5594052&sid=XY8">🖇️</a>
+      <a href="https://github.com/natalie-klein">🐙</a>
+    <td align="center">
+      <img src="https://avatars.githubusercontent.com/u/80185584?v=4" width="140px;" alt=""/>
+      <br />
+      <sub><b>Jacob Alexander</b></sub>
+      <br />
+      <a href="https://www.linkedin.com/search/results/all/?fetchDeterministicClustersOnly=false&heroEntityKey=urn%3Ali%3Afsd_profile%3AACoAAAnv9wwBJJ9SgtkuND-IT1hQIl6hVS50AJ4&keywords=mike%20masatsugu&origin=RICH_QUERY_SUGGESTION&position=0&searchId=51ea03d4-28fa-431c-b97c-df470d78d606&sid=~Ov">🖇️</a>
+      <a href="https://github.com/mikemasatsugu">🐙</a>
+    </td>
+</table>
+
+
+- 🖇️ = LinkedIn
+- 🐙 = Github
+  
 ## Notes to Self:
 **Structure of the files:**
 
@@ -64,55 +185,7 @@ if you write name that it will overwrite the keys
 **Tech Challenges**
 Spent 3 days dealing with inconsistencies of ES6/CommonJS in our code before compiling .js in ES6
 
-**Files to Delete**
-App.js
-App.tsx
-tailwind.css?
-tailwind.config.js
-input.css?
-postcss.config.js
-server(folder)
-coverage (folder)
-bin (folder)
-template.html
-testlogger.js 
-
--->webpack.config.js?  **Test renaming to see if it breaks.  
-
-Package json: 
-    "@babel/core": "^7.25.7",
-    "@babel/plugin-transform-runtime": "^7.25.7",
-    "@babel/preset-env": "^7.25.8",
-    "@babel/preset-react": "^7.25.7",
-    "@babel/runtime": "^7.25.7",
-    "babel-eslint": "^10.1.0",
-    "babel-loader": "^9.2.1",
-    "cross-env": "^7.0.3",
-    "css-loader": "^7.1.2",
-    "html-webpack-plugin": "^5.6.0",
-    "node-mocks-http": "^1.16.1",
-    "nodemon": "^3.1.7",
-    "postcss": "^8.4.49",
-    "postcss-loader": "^8.1.1",
-    "postcss-preset-env": "^10.1.1",
-    "sass": "^1.80.5",
-    "sass-loader": "^16.0.2",
-    "style-loader": "^4.0.0",
-    "tailwindcss": "^3.4.15",
-    "webpack": "^5.95.0",
-    "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.1.0"
-    "bcrypt": "^5.1.1",
-    "cookie-parser": "^1.4.7",
-    "cors": "^2.8.5",
-    "express": "^4.21.1",
-    "express-session": "^1.18.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-router-dom": "^6.27.0"
-
-**npmignore**
-lambda-nodejs22.x
-
-**gitignore**
-lambda-nodejs22.x
+**To DO LIST ITEMS**
+- How can the user visaulize the cache growing in real time?
+- Creating more professional scrreenshots for the ReadMe - to replace the current ReadMe screenshots
+- Add License Information

package/client/index.js

@@ -11,31 +11,39 @@ import { Logger } from "@aws-lambda-powertools/logger";
 import { Ajv } from "ajv";
 //cache entries are structured thusly: 'Namespace + Dimensions(Alphabetically)': EMFObject
 const cache = {};
-//catalog(kilos, "kilos" , "lambda-function-metrics", "Kilograms", {'functionVersion': $LATEST, 'testDimension': derp});
-function catalog(trackedVariable_1, metricName_1, metricNamespace_1) {
-    return __awaiter(this, arguments, void 0, function* (trackedVariable, metricName, metricNamespace, metricUnitLabel = "None", CustomerDefinedDimension = {}, resolution = 60, deploy = false) {
+//let latency = 300; (Example metric to track)
+//Example for in-line use of Cat-a-log w/maximum arguments: catalog(latency, "Latency" , "lambda-function-metrics", "Milliseconds", {'functionVersion': '$LATEST', 'Server': 'Prod'}, 60, deploy);
+//Example for in-line use of Cat-a-log w/minimum arguments: catalog(latency, "Latency");
+function catalog(trackedVariable_1, metricName_1) {
+    return __awaiter(this, arguments, void 0, function* (trackedVariable, metricName, metricNamespace = "CatALog-Default-Metrics", metricUnitLabel = "None", CustomerDefinedDimension = {}, resolution = 60, deploy = false) {
         //Check for any errors & validate inputs based on documentations
         if (!cache)
             throw new Error("cache is not found, please import cache from cat-a-log");
-        console.log(Object.keys(CustomerDefinedDimension).concat([metricName.toLowerCase()]));
+        //check if any provided dimension names or metric names conflict with native logger keys.
         const badKeys = ["level", "message", "sampling_rate", "service", "timestamp", "xray_trace_id"];
         const yourKeys = Object.keys(CustomerDefinedDimension).concat([metricName.toLowerCase()]);
         for (let i = 0; i < yourKeys.length; i++) {
             if (badKeys.includes(yourKeys[i])) {
+                //if a dimension name or metric name conflicts with native logger keys, throw error
                 throw new Error("metricName, or Dimension names cannot be the same as these native logger keys: level || message || sampling_rate || service || timestamp || xray_trace_id");
             }
         }
+        //EMF specification catch: if tracked variable is an array with a length greater than 100, throw error and do not log
         if (Array.isArray(trackedVariable)) {
             if (trackedVariable.length > 100)
                 throw new Error("metric value cannot have more than 100 elements");
         }
-        if (Object.keys(CustomerDefinedDimension).length > 30) {
-            throw new Error("EMF has a limit of 30 user defined dimension keys per log");
-        }
+        //EMF specification catch: make sure provided dimension object does not have more than 30 entries
+        // if (Object.keys(CustomerDefinedDimension).length > 30) {
+        //   throw new Error(
+        //     "EMF has a limit of 30 user defined dimension keys per log"
+        //   );
+        // }
+        //Create new instance of Logger to use in function
         const logger = new Logger({ serviceName: "serverlessAirline" });
-        // Ajv instance
+        //Set up Ajv instance for JSON validation
         const ajv = new Ajv();
-        // from AWS: EMF schema to test/validate against
+        // from AWS: EMF schema to test/validate against with Ajv
         const emfSchema = {
             type: "object",
             title: "Root Node",
@@ -136,29 +144,29 @@ function catalog(trackedVariable_1, metricName_1, metricNamespace_1) {
                 },
             },
         };
+        //usable instance of the validation JSON
         const validateEmf = ajv.compile(emfSchema);
-        //sort customerDimensions key values in alphabetical order
+        //sort customerDimensions key values in alphabetical order. We will use this to keep the keys in our cache consistant. Since the order of the dimensions do not change where the metrics are stored
         const sortedDimensions = {};
         for (let i = 0; i < Object.keys(CustomerDefinedDimension).sort().length; i++) {
             sortedDimensions[Object.keys(CustomerDefinedDimension).sort()[i]] =
                 CustomerDefinedDimension[Object.keys(CustomerDefinedDimension).sort()[i]];
         }
-        //if Object with Namespace and Dimensions already exists in Set
+        //Check if Object with Namespace and Dimensions already exists in cache
         let check = cache[`${metricNamespace}${sortedDimensions}`];
         if (check != undefined) {
-            //push the metrics object to Metrics array
+            //if the Namespace and Dimensions exist, push the metrics object to Metrics array
             cache[`${metricNamespace}${sortedDimensions}`]["_aws"]["CloudWatchMetrics"][0]["Metrics"].push({
                 Name: metricName,
                 Unit: metricUnitLabel,
                 StorageResolution: resolution,
             });
-            //add key value to Log
+            //add key value to root of existing structured Log
             check[`${metricName}`] = trackedVariable;
         }
         else {
-            // //create new Structured Log and add it to cachedStructuredLogs  - BMA 1/18/25 removed to test Ajv
-            // cache[`${metricNamespace}${sortedDimensions}`] = Object.assign(
-            // NameSpace & Dimensions for EMF part don't exist yet.  Initialize variable to capture EMF/aws key:value pair
+            //create new Structured Log and add it to cachedStructuredLogs
+            //If NameSpace & Dimensions for EMF part don't exist yet, initialize variable to capture EMF/aws key:value pair
             const newEmfLog = Object.assign({
                 _aws: {
                     Timestamp: Date.now(),
@@ -182,16 +190,12 @@ function catalog(trackedVariable_1, metricName_1, metricNamespace_1) {
             console.log("index.ts - Unit value before validation: ", newEmfLog._aws.CloudWatchMetrics[0].Metrics[0].Unit);
             // validate the new EMF JSON schema against AWS EMF JSON schema before adding to cache object
             const isValid = validateEmf(newEmfLog);
-            // //troubleshooting console.error in test
-            // console.log('index.ts - Validation result: ', isValid);
-            // troubleshooting console.error in emf test
-            // console.log('index.ts - Validation errors: ', validateEmf.errors);
-            // if it fails validation throw error
+            // if the new EMF object fails validation, throw error and do not cache flawed object
             if (!isValid) {
                 console.error("An error occurred during EMF validation: ", validateEmf.errors);
                 throw new Error("Supplied/Proposed structured log does not comply with EMF schema");
             }
-            // If it passes then add to cache object
+            // If the new EMF object passes validation then add to cache object
             cache[`${metricNamespace}${sortedDimensions}`] = newEmfLog;
         }
         if (deploy) {
@@ -199,7 +203,7 @@ function catalog(trackedVariable_1, metricName_1, metricNamespace_1) {
             for (let i = 0; i < Object.keys(cache).length; i++) {
                 logger.info(`Your EMF compliant Structured Metrics Log ${i + 1}`, cache[Object.keys(cache)[i]]);
             }
-            //clear cache
+            //clear cache after logging all cached objects to Lambda
             console.log("BEFORE:", cache);
             for (var member in cache)
                 delete cache[member];
@@ -208,54 +212,3 @@ function catalog(trackedVariable_1, metricName_1, metricNamespace_1) {
     });
 }
 export { cache, catalog };
-/*Current Working logger invocation
-logger.info("Your EMF compliant Structured Metrics Log",
-  Object.assign({
-    _aws: {
-      Timestamp: Date.now(),
-      CloudWatchMetrics: [
-        {
-          Namespace: metricNamespace,
-          Dimensions: [Object.keys(CustomerDefinedDimension)],
-          Metrics: [
-            {
-              Name: metricName,
-              Unit: metricUnitLabel,
-              StorageResolution: resolution,
-            }
-          ]
-        }
-      ]
-    },
-    [`${metricName}`]: trackedVariable,
-    },
-      CustomerDefinedDimension
-    )
-  
-)
-*/
-//Old handler function
-// export const handler = async (_event, _context): Promise<void> => {
-//   const testObj = {
-//     testguy: "hi",
-//     fool: 42,
-//     functionVersion: "$LATEST",
-//     _aws: {
-//       Timestamp: Date.now(),
-//       CloudWatchMetrics: [
-//         {
-//           Namespace: "lambda-function-metrics",
-//           Dimensions: [["functionVersion"]],
-//           Metrics: [
-//             {
-//               Name: "fool",
-//               Unit: "Milliseconds",
-//               StorageResolution: 60
-//             }
-//           ]
-//         }
-//       ]
-//     },
-//   }
-//   logger.info(JSON.stringify(testObj));
-// };

package/client/index.ts

@@ -3,11 +3,13 @@ import { Ajv } from "ajv";
 
 //cache entries are structured thusly: 'Namespace + Dimensions(Alphabetically)': EMFObject
 const cache: { [key: string]: any } = {};
-//catalog(kilos, "kilos" , "lambda-function-metrics", "Kilograms", {'functionVersion': $LATEST, 'testDimension': derp});
+//let latency = 300; (Example metric to track)
+//Example for in-line use of Cat-a-log w/maximum arguments: catalog(latency, "Latency" , "lambda-function-metrics", "Milliseconds", {'functionVersion': '$LATEST', 'Server': 'Prod'}, 60, deploy);
+//Example for in-line use of Cat-a-log w/minimum arguments: catalog(latency, "Latency");
 async function catalog(
   trackedVariable: number | Array<number>,
   metricName: string,
-  metricNamespace: string,
+  metricNamespace: string = "CatALog-Default-Metrics",
   metricUnitLabel: string = "None",
   CustomerDefinedDimension: { [key: string]: string } = {},
   resolution: 1 | 60 = 60,
@@ -16,11 +18,12 @@ async function catalog(
   //Check for any errors & validate inputs based on documentations
   if (!cache)
     throw new Error("cache is not found, please import cache from cat-a-log");
-  console.log(Object.keys(CustomerDefinedDimension).concat([metricName.toLowerCase()]));
+  //check if any provided dimension names or metric names conflict with native logger keys.
   const badKeys = ["level", "message", "sampling_rate", "service", "timestamp", "xray_trace_id"];
   const yourKeys = Object.keys(CustomerDefinedDimension).concat([metricName.toLowerCase()]);
   for(let i = 0; i < yourKeys.length; i++){
     if(badKeys.includes(yourKeys[i])){
+      //if a dimension name or metric name conflicts with native logger keys, throw error
       throw new Error(
         "metricName, or Dimension names cannot be the same as these native logger keys: level || message || sampling_rate || service || timestamp || xray_trace_id"
       );
@@ -28,20 +31,22 @@ async function catalog(
   }
     
   
-    
+  //EMF specification catch: if tracked variable is an array with a length greater than 100, throw error and do not log
   if (Array.isArray(trackedVariable)) {
     if (trackedVariable.length > 100)
       throw new Error("metric value cannot have more than 100 elements");
   }
-  if (Object.keys(CustomerDefinedDimension).length > 30) {
-    throw new Error(
-      "EMF has a limit of 30 user defined dimension keys per log"
-    );
-  }
+  //EMF specification catch: make sure provided dimension object does not have more than 30 entries
+  // if (Object.keys(CustomerDefinedDimension).length > 30) {
+  //   throw new Error(
+  //     "EMF has a limit of 30 user defined dimension keys per log"
+  //   );
+  // }
+  //Create new instance of Logger to use in function
   const logger = new Logger({ serviceName: "serverlessAirline" });
-  // Ajv instance
+  //Set up Ajv instance for JSON validation
   const ajv = new Ajv();
-  // from AWS: EMF schema to test/validate against
+  // from AWS: EMF schema to test/validate against with Ajv
   const emfSchema = {
     type: "object",
     title: "Root Node",
@@ -143,9 +148,9 @@ async function catalog(
       },
     },
   };
-
+  //usable instance of the validation JSON
   const validateEmf = ajv.compile(emfSchema);
-  //sort customerDimensions key values in alphabetical order
+  //sort customerDimensions key values in alphabetical order. We will use this to keep the keys in our cache consistant. Since the order of the dimensions do not change where the metrics are stored
   const sortedDimensions: { [key: string]: string } = {};
   for (
     let i = 0;
@@ -155,10 +160,10 @@ async function catalog(
     sortedDimensions[Object.keys(CustomerDefinedDimension).sort()[i]] =
       CustomerDefinedDimension[Object.keys(CustomerDefinedDimension).sort()[i]];
   }
-  //if Object with Namespace and Dimensions already exists in Set
+  //Check if Object with Namespace and Dimensions already exists in cache
   let check = cache[`${metricNamespace}${sortedDimensions}`];
   if (check != undefined) {
-    //push the metrics object to Metrics array
+    //if the Namespace and Dimensions exist, push the metrics object to Metrics array
     cache[`${metricNamespace}${sortedDimensions}`]["_aws"][
       "CloudWatchMetrics"
     ][0]["Metrics"].push({
@@ -166,12 +171,11 @@ async function catalog(
       Unit: metricUnitLabel,
       StorageResolution: resolution,
     });
-    //add key value to Log
+    //add key value to root of existing structured Log
     check[`${metricName}`] = trackedVariable;
   } else {
-    // //create new Structured Log and add it to cachedStructuredLogs  - BMA 1/18/25 removed to test Ajv
-    // cache[`${metricNamespace}${sortedDimensions}`] = Object.assign(
-    // NameSpace & Dimensions for EMF part don't exist yet.  Initialize variable to capture EMF/aws key:value pair
+    //create new Structured Log and add it to cachedStructuredLogs
+    //If NameSpace & Dimensions for EMF part don't exist yet, initialize variable to capture EMF/aws key:value pair
     const newEmfLog = Object.assign(
       {
         _aws: {
@@ -203,9 +207,7 @@ async function catalog(
 
     // validate the new EMF JSON schema against AWS EMF JSON schema before adding to cache object
     const isValid = validateEmf(newEmfLog);
-    // //troubleshooting console.error in test
-    // troubleshooting console.error in emf test
-    // if it fails validation throw error
+    // if the new EMF object fails validation, throw error and do not cache flawed object
     if (!isValid) {
       console.error(
         "An error occurred during EMF validation: ",
@@ -215,7 +217,7 @@ async function catalog(
         "Supplied/Proposed structured log does not comply with EMF schema"
       );
     }
-    // If it passes then add to cache object
+    // If the new EMF object passes validation then add to cache object
     cache[`${metricNamespace}${sortedDimensions}`] = newEmfLog;
   }
 
@@ -227,7 +229,7 @@ async function catalog(
         cache[Object.keys(cache)[i]]
       );
     }
-    //clear cache
+    //clear cache after logging all cached objects to Lambda
     console.log("BEFORE:", cache);
     for (var member in cache) delete cache[member];
     console.log("AFTER:", cache);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cat-a-logs",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Create & send structured logs to AWS Cloudwatch logs",
   "main": "index.js",
   "exports":{

package/tsconfig.json

@@ -59,7 +59,7 @@
     "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
      "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
+    "removeComments": true,                           /* Disable emitting comments. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
     // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */