add gzip

Author: Ankcorn

CHANGELOG.md

@@ -5,16 +5,14 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.1.14] 2023-07-07
+
+- Add lots of aws lambda resource spans
+- GZIP
+
 ## [0.1.13] 2023-07-05
 
 - Make sure flushing is not canceled
-  
- The latest layer is: `arn:aws:lambda:${your-region-here}:097948374213:layer:baselime-node:9`
- 
- The latest layer is: `arn:aws:lambda:${your-region-here}:374211872663:layer:baselime-node:17`
-
- 
- The latest layer is: `arn:aws:lambda:${your-region-here}:374211872663:layer:baselime-node:18`
 
 ## [0.1.12] 2023-06-28
 

multiRegion.json

@@ -1,6 +1,16 @@
 {
     "regions": [
-        "eu-west-2"
+        "eu-west-1",
+        "eu-west-2",
+        "us-east-1",
+        "us-east-2",
+        "us-west-2",
+        "eu-central-1",
+        "ap-south-1",
+        "ap-southeast-1",
+        "ap-southeast-2",
+        "ap-northeast-1",
+        "ca-central-1"
     ],
     "output": "md"
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@baselime/lambda-node-opentelemetry",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "OpenTelemetry auto tracer for Node.JS based AWS Lambda functions",
   "keywords": [
     "nodejs",
@@ -37,6 +37,7 @@
   "homepage": "https://github.com/Baselime/tracer-node#readme",
   "devDependencies": {
     "@tsconfig/node16": "^1.0.4",
+    "@types/flat": "^5.0.2",
     "@types/node": "^20.1.7",
     "aws-cdk-lib": "2.79.1",
     "constructs": "10.1.156",
@@ -54,6 +55,7 @@
     "@opentelemetry/instrumentation-aws-sdk": "^0.34.2",
     "@opentelemetry/instrumentation-http": "^0.40.0",
     "@opentelemetry/sdk-trace-base": "^1.14.0",
-    "@opentelemetry/sdk-trace-node": "^1.14.0"
+    "@opentelemetry/sdk-trace-node": "^1.14.0",
+    "flat": "^5.0.2"
   }
 }

package.json

@@ -1,11 +1,11 @@
 import api, { trace, context, propagation, Context as OtelContext, ROOT_CONTEXT, Attributes } from "@opentelemetry/api";
 import { Handler, DynamoDBStreamEvent, S3Event } from "aws-lambda";
-import { flattenObject } from './utils';
+import { flatten } from "flat"
 import { Context } from 'aws-lambda';
 export * as logger from './logger';
 
-declare const global : {
-	baselimeLambdaFlush: () => Promise<void>;
+declare const global: {
+  baselimeLambdaFlush: () => Promise<void>;
 }
 
 type FaasDocument = {
@@ -23,17 +23,17 @@ export function wrap(handler: Handler) {
     const trigger = triggerToServiceType(service);
     const parent = determinParent(event, service);
     let document: FaasDocument | null = null;
-    if(trigger === 'datasource') {
-      if(service === 'dynamodb') {
+    if (trigger === 'datasource') {
+      if (service === 'dynamodb') {
         document = getDynamodbStreamDocumentAttributes(event);
-      } 
+      }
 
-      if(service === 's3') {
+      if (service === 's3') {
         document = getS3DocumentAttributes(event);
       }
     }
     const span = tracer.startSpan(lambda_context.functionName, {
-      attributes: flattenObject({
+      attributes: flatten({
         event,
         context: lambda_context,
         faas: {
@@ -53,16 +53,16 @@ export function wrap(handler: Handler) {
     }, parent);
     coldstart = false;
     const ctx = trace.setSpan(context.active(), span);
-    
+
     try {
       const result = await context.with(ctx, handler as (args: any[]) => any, null, event, lambda_context);
-      span.setAttributes(flattenObject(result, 'result') as Attributes);
+      span.setAttributes(flatten({ result }) as Attributes);
       span.end();
       return result;
     } catch (e) {
       const err = e as Error;
       span.recordException(err);
-      span.setAttributes(flattenObject({ name: err.name, message: err.message, stack: err.stack }, 'error') as Attributes);
+      span.setAttributes(flatten({ error: { name: err.name, message: err.message, stack: err.stack } }) as Attributes);
       span.end();
       throw e
     } finally {
@@ -75,35 +75,35 @@ export function wrap(handler: Handler) {
 
 
 function detectService(event: any) {
-	if (event.requestContext?.apiId) {
-		return "api-gateway";
-	}
+  if (event.requestContext?.apiId) {
+    return "api-gateway";
+  }
 
-  if(event.requestContext?.apiId && event.version === "2.0") {
+  if (event.requestContext?.apiId && event.version === "2.0") {
     return "api-gateway-v2";
   }
 
-	if (event.Records && event.Records[0]?.EventSource === "aws:sns") {
-		return "sns";
-	}
+  if (event.Records && event.Records[0]?.EventSource === "aws:sns") {
+    return "sns";
+  }
 
-  if(event.Records && event.Records[0]?.eventSource === "aws:sqs") {
+  if (event.Records && event.Records[0]?.eventSource === "aws:sqs") {
     return "sqs";
   }
 
-  if(event.Records && event.Records[0]?.eventSource === "aws:kinesis") {
+  if (event.Records && event.Records[0]?.eventSource === "aws:kinesis") {
     return "kinesis";
   }
 
-  if(event.Records && event.Records[0]?.eventSource === "aws:dynamodb") {
+  if (event.Records && event.Records[0]?.eventSource === "aws:dynamodb") {
     return "dynamodb";
   }
 
-  if(event.Records && event.Records[0]?.eventSource === "aws:s3") {
+  if (event.Records && event.Records[0]?.eventSource === "aws:s3") {
     return "s3";
   }
 
-	return 'unknown'
+  return 'unknown'
 }
 
 function triggerToServiceType(service: string) {
@@ -127,21 +127,21 @@ function triggerToServiceType(service: string) {
 }
 
 const headerGetter = {
-	keys(carrier: Object): string[] {
-		return Object.keys(carrier);
-	},
-	get(carrier: Record<string, string>, key: string): string | undefined {
-		return carrier[key];
-	},
+  keys(carrier: Object): string[] {
+    return Object.keys(carrier);
+  },
+  get(carrier: Record<string, string>, key: string): string | undefined {
+    return carrier[key];
+  },
 };
 
 const snsGetter = {
-	keys(carrier:Object): string[] {
-		return Object.keys(carrier);
-	},
-	get(carrier: Record<string, { Value: string }>, key: string): string | undefined {
-		return carrier[key]?.Value;
-	},
+  keys(carrier: Object): string[] {
+    return Object.keys(carrier);
+  },
+  get(carrier: Record<string, { Value: string }>, key: string): string | undefined {
+    return carrier[key]?.Value;
+  },
 };
 
 function determinParent(event: any, service: string): OtelContext {
@@ -153,7 +153,7 @@ function determinParent(event: any, service: string): OtelContext {
     return extractedContext;
   }
 
-  if(!parent) {
+  if (!parent) {
     return ROOT_CONTEXT
   }
   return parent;
@@ -190,7 +190,7 @@ const DynamodbEventToDocumentOperations = {
 
 function getDynamodbStreamDocumentAttributes(event: DynamoDBStreamEvent): FaasDocument {
   const unixTime = event?.Records[0]?.dynamodb?.ApproximateCreationDateTime || Date.now() / 1000;
-  return { 
+  return {
     // TODO we could do better for collection (infer from single table design patterns?)
     collection: (event?.Records[0]?.eventSourceARN || '').split("/")[1],
     name: (event?.Records[0]?.eventSourceARN || '').split("/")[1],
@@ -202,11 +202,11 @@ function getDynamodbStreamDocumentAttributes(event: DynamoDBStreamEvent): FaasDo
 function getS3DocumentAttributes(event: S3Event): FaasDocument {
   let operation = 'unkown';
 
-  if(event.Records[0].eventName.startsWith('ObjectCreated')) {
+  if (event.Records[0].eventName.startsWith('ObjectCreated')) {
     operation = 'insert';
   }
-  
-  if(event.Records[0].eventName.startsWith('ObjectRemoved')) {
+
+  if (event.Records[0].eventName.startsWith('ObjectRemoved')) {
     operation = 'delete';
   }
   return {

src/index.ts

@@ -1,7 +1,7 @@
 import api, { Attributes, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
 import {
-	OTLPTraceExporter, 
+	OTLPTraceExporter,
 } from "@opentelemetry/exporter-trace-otlp-http";
 import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
 import { Instrumentation, registerInstrumentations } from "@opentelemetry/instrumentation";
@@ -10,7 +10,7 @@ import {
 } from "@opentelemetry/instrumentation-aws-sdk";
 import { HttpInstrumentation } from "@opentelemetry/instrumentation-http";
 import { Resource } from "@opentelemetry/resources";
-import { flattenObject } from "./utils";
+import { flatten } from "flat";
 import { existsSync } from "node:fs";
 import { arch } from "node:os"
 if (process.env.OTEL_LOG_LEVEL === "debug") {
@@ -32,15 +32,15 @@ const provider = new NodeTracerProvider({
 let collectorURL: string = process.env.COLLECTOR_URL || "https://otel.baselime.io/v1"
 
 if (existsSync('/opt/extensions/baselime')) {
-	collectorURL = 'http://sandbox:4323';
+	collectorURL = 'http://sandbox:4323/otel';
 }
 
 enum CompressionAlgorithm {
 	GZIP = "gzip",
 }
 const spanProcessor = new BatchSpanProcessor(
 	new OTLPTraceExporter({
-		url: `${collectorURL}/${process.env.AWS_LAMBDA_FUNCTION_NAME}`,
+		url: collectorURL,
 		compression: CompressionAlgorithm.GZIP,
 		headers: {
 			"x-api-key": process.env.BASELIME_KEY || process.env.BASELIME_OTEL_KEY,
@@ -60,7 +60,7 @@ const instrumentations: Instrumentation[] = [
 					request: response.request,
 					response: response.data,
 				};
-			span.setAttributes(flattenObject(awsApiReqData) as Attributes);
+				span.setAttributes(flatten(awsApiReqData) as Attributes);
 			}
 		},
 	}),
@@ -71,7 +71,7 @@ registerInstrumentations({
 	instrumentations
 });
 
-declare const global : {
+declare const global: {
 	baselimeLambdaFlush: () => void;
 }
 
@@ -81,7 +81,7 @@ global['baselimeLambdaFlush'] = async () => {
 
 		// TODO figure out why this is 20ms on cold start vs 3 ms on regular invocation
 		await provider.forceFlush();
-	} catch(e) {
+	} catch (e) {
 		console.log(e)
 	}
 };