fix(logger): environment attributes, polishing

Author: saragerion

packages/logger/examples/custom-logger-options.ts

@@ -42,3 +42,35 @@ const lambdaHandler: Handler = async (event, context) => {
 };
 
 lambdaHandler(dummyEvent, dummyContext, () => {});
+
+/**
+ * Sample output:
+ *
+ * {
+ *   message: 'This is an ERROR log',
+ *   service: 'foo-bar',
+ *   environment: 'prod',
+ *   awsRegion: 'eu-central-1',
+ *   correlationIds: {
+ *     awsRequestId: 'c6af9ac6-7b61-11e6-9a41-93e8deadbeef',
+ *     xRayTraceId: 'abcdef123456abcdef123456abcdef123456',
+ *     myCustomCorrelationId: 'foo-bar-baz'
+ *   },
+ *   lambdaFunction: {
+ *     name: 'foo-bar-function',
+ *     arn: 'arn:aws:lambda:eu-central-1:123456789012:function:Example',
+ *     memoryLimitInMB: 128,
+ *     version: '$LATEST',
+ *     coldStart: undefined
+ *   },
+ *   logLevel: 'ERROR',
+ *   timestamp: '2021-03-10T18:47:04.724Z',
+ *   logger: {
+ *     name: '@aws-lambda-powertools/logger',
+ *     version: '0.0.0',
+ *     level: 'ERROR',
+ *     sampleRateValue: 0.00001
+ *   }
+ * }
+ *
+ **/

packages/logger/examples/formatters/CustomLogFormatter.ts

@@ -1,4 +1,4 @@
-/* eslint-disable sort-keys */
+import * as powertool from '../../package.json';
 import { LogFormatter } from '../../src/formatter';
 import { LogAttributes, UnformattedAttributes } from '../../types';
 
@@ -9,15 +9,9 @@ class CustomLogFormatter extends LogFormatter {
   public format(attributes: UnformattedAttributes): MyCompanyLog {
     return {
       message: attributes.message,
-      timestamp: this.formatTimestamp(attributes.timestamp),
-      logLevel: attributes.logLevel,
       service: attributes.serviceName,
-      env: attributes.environment,
+      environment: attributes.environment,
       awsRegion: attributes.awsRegion,
-      logger: {
-        level: attributes.logLevel,
-        sampleRateValue: attributes.sampleRateValue,
-      },
       correlationIds: {
         awsRequestId: attributes.awsRequestId,
         xRayTraceId: attributes.xRayTraceId
@@ -29,6 +23,14 @@ class CustomLogFormatter extends LogFormatter {
         version: attributes.functionVersion,
         coldStart: attributes.coldStart,
       },
+      logLevel: attributes.logLevel,
+      timestamp: this.formatTimestamp(attributes.timestamp),
+      logger: {
+        name: powertool.name,
+        version: powertool.version,
+        level: attributes.logLevel,
+        sampleRateValue: attributes.sampleRateValue,
+      },
     };
   }
 

packages/logger/src/Logger.ts

@@ -10,7 +10,7 @@ import {
   LogAttributes,
   LoggerOptions,
   LogLevel,
-  LogLevelThresholds,
+  LogLevelThresholds, UnformattedAttributes,
 } from '../types';
 import { LogFormatterInterface, PowertoolLogFormatter } from './formatter';
 
@@ -107,7 +107,7 @@ class Logger implements LoggerInterface {
   private createLogItem(logLevel: LogLevel, message: string, customAttributes: LogAttributes = {}): LogItem {
     this.addToDefaultLoggerAttributes({ logLevel, message, timestamp: new Date() });
 
-    return new LogItem().addAttributes(this.getLogFormatter().format(this.getDefaultLoggerAttributes()))
+    return new LogItem().addAttributes(this.getLogFormatter().format(this.getDefaultLoggerAttributes() as UnformattedAttributes))
       .addAttributes(customAttributes);
   }
 
@@ -150,7 +150,7 @@ class Logger implements LoggerInterface {
   private populateDefaultLoggerAttributes(serviceName?: string, environment?: Environment, customAttributes: LogAttributes = {}): void {
     this.addToDefaultLoggerAttributes({
       awsRegion: this.getEnvVarsService().getAwsRegion(),
-      env: environment || this.getCustomConfigService()?.getCurrentEnvironment() || this.getEnvVarsService().getCurrentEnvironment(),
+      environment: environment || this.getCustomConfigService()?.getCurrentEnvironment() || this.getEnvVarsService().getCurrentEnvironment(),
       functionName: this.getEnvVarsService().getFunctionName(),
       functionVersion: this.getEnvVarsService().getFunctionVersion(),
       logLevel: this.getLogLevel(),

packages/logger/types/Logger.ts

@@ -30,7 +30,7 @@ type DefaultLoggerAttributes = LogAttributes | {[key in keyof Context]: Context[
   message?: string
 };
 
-type UnformattedAttributes = DefaultLoggerAttributes & {
+type UnformattedAttributes = LogAttributes & DefaultLoggerAttributes & {
   awsRequestId?: string
   environment?: Environment
   serviceName: string