cat-a-logs 2.0.4 → 2.0.6

package/README.md

@@ -32,7 +32,7 @@ EMF is a JSON specification that enables CloudWatch Logs to automatically extrac
 Your chosen Integrated Development Environment (i.e. VS Code) must already be connected to AWS Lambda. For more guidance on setting up AWS Lambda we recommend following this helpful tutorial from AWS: <a href="https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-getting-started-hello-world.html" target="_blank">Deploy Hello World Application with AWS SAM</a>
 
 **Installation:**
-1. Install our package using the command `npm install cat-a-logs` then import the function into your js file that connects to AWS Lambda `import { catalog } from "cat-a-logs/index.js";` Check out Cat-A-Log on npm using the attached link:
+1. Install our package using the command `npm install cat-a-logs` then import the functions into your js file that connects to AWS Lambda `import { deployCatalog, catalog } from "cat-a-logs/index.js";` Check out Cat-A-Log on npm using the attached link:
 <a href="https://www.npmjs.com/package/cat-a-logs?activeTab=readme" target="_blank">Cat-A-Log</a>
 
 2. Now enter your arguments into the catalog function! Let's go through each parameter one at a time and see what this looks like. First let's take a look at the function definition:
@@ -95,14 +95,7 @@ Your chosen Integrated Development Environment (i.e. VS Code) must already be co
 
 
 4. ON the very last function call - it is important to change the deploy parameter to `true`. 
-    ```
-      function catalog(
-        .
-        .
-        .
-        .
-        deploy: boolean = true)
-      ```
+     - Alternative approach is to deploy your Lambda function with the `deployCatalog()` function call. This will automatically publish to CloudWatch without the need to use the entire arguments required in Cat-A-Log. Place `deployCatalog()` after you last catalog function call.
 
 5. Deploy your code with AWS SAM. This will place the file in AWS Lambda waiting for invocation. If you would like to learn more about deploying with SAM please follow the attached
           <a href= "https://docs.aws.amazon.com/lambda/latest/dg/testing-functions.html" target="_blank">link</a>

package/client/index.ts

@@ -1,7 +1,7 @@
 import { Logger } from "@aws-lambda-powertools/logger";
 import { Ajv } from "ajv";
 
-//cache entries are structured thusly: 'Namespace + Dimensions(Alphabetically)': EMFObject
+//cache entries are structured thusly: 'Namespace + DimensionsKeys(Alphabetically)': EMFObject
 const cache: { [key: string]: any } = {};
 //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);
@@ -25,7 +25,7 @@ async function catalog(
     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"
+        "metricName, or Dimension names CANNOT be the same as these native Logger keys: level || message || sampling_rate || service || timestamp || xray_trace_id"
       );
     }
   }
@@ -37,11 +37,11 @@ async function catalog(
       throw new Error("metric value cannot have more than 100 elements");
   }
   //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"
-  //   );
-  // }
+  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" });
   //Set up Ajv instance for JSON validation
@@ -230,9 +230,26 @@ async function catalog(
       );
     }
     //clear cache after logging all cached objects to Lambda
-    console.log("BEFORE:", cache);
+    console.log("BEFORE:", JSON.stringify(cache, null, 2));
     for (var member in cache) delete cache[member];
     console.log("AFTER:", cache);
   }
 }
-export { cache, catalog };
+
+//If you want to manually deploy the cache without writing a catalog for it
+async function deployCatalog() {
+  //Create a new instance of Logger
+  const logger = new Logger({ serviceName: "serverlessAirline" });
+  //Log all cached objects to Cloudwatch through Lambda
+  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 after logging all cached objects to Lambda
+  console.log("BEFORE:", JSON.stringify(cache, null, 2));
+  for (var member in cache) delete cache[member];
+  console.log("AFTER:", cache);
+}
+export { cache, catalog, deployCatalog };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "cat-a-logs",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "description": "Create & send structured logs to AWS Cloudwatch logs",
   "main": "index.js",
-  "exports":{
+  "exports": {
     "./index.js": "./client/index.js"
   },
   "scripts": {