Docs: Custom Log Formatter Example disappeared from documentation

[ValeryShvyndzikau]

What were you searching in the docs?

Hi AWS Lambda Powertools Team

It looks like Custom Log Formatter Example was accidentally removed in the scope of migration to separate files
Here is a link to the corresponding PR https://github.com/awslabs/aws-lambda-powertools-typescript/pull/1230/files#diff-e42af4aee30a146e6e51be432c4a80c93e50d552f7b70403fa301ecf11d355c4

Is this related to an existing documentation section?

No response

How can we improve?

Get back Custom Formatter Example

Got a suggestion in mind?

No response

Acknowledgment

• I understand the final update might be different from my proposed suggestion, or refused.

[dreamorosi]

Hi @ValeryShvyndzikau, thanks for reporting this!

You're right, there must have been a copy/paste issue and indeed the code snippet got removed (although it's still in the git history).

Would you be interested in contributing a PR to bring it back? If yes I'd be happy to help you get it merged quickly. If not, that's alright and we'll put it in the backlog for someone else to pick it up.

[niko-achilles]

@dreamorosi i could take it if needed. It is a copy paste thing.

I would apply the following in bringYourOwnFormatterClass.ts code snippet that is extracted in docs/snippets/logger .

import { LogFormatter } from "@aws-lambda-powertools/logger";
import {
  LogAttributes,
  UnformattedAttributes,
} from "@aws-lambda-powertools/logger/lib/types";

// Replace this line with your own type
type MyCompanyLog = LogAttributes;

class MyCompanyLogFormatter extends LogFormatter {
  public formatAttributes(attributes: UnformattedAttributes): MyCompanyLog {
    return {
      message: attributes.message,
      service: attributes.serviceName,
      environment: attributes.environment,
      awsRegion: attributes.awsRegion,
      correlationIds: {
        awsRequestId: attributes.lambdaContext?.awsRequestId,
        xRayTraceId: attributes.xRayTraceId,
      },
      lambdaFunction: {
        name: attributes.lambdaContext?.functionName,
        arn: attributes.lambdaContext?.invokedFunctionArn,
        memoryLimitInMB: attributes.lambdaContext?.memoryLimitInMB,
        version: attributes.lambdaContext?.functionVersion,
        coldStart: attributes.lambdaContext?.coldStart,
      },
      logLevel: attributes.logLevel,
      timestamp: this.formatTimestamp(attributes.timestamp), // You can extend this function
      logger: {
        sampleRateValue: attributes.sampleRateValue,
      },
    };
  }
}

export { MyCompanyLogFormatter };

[dreamorosi]

Great, thank you Niko, that would be the fix.

[niko-achilles]

@dreamorosi PR for fixing this issue: #1254 . I was around in the repo looking at things , and i saw this issue raised by @ValeryShvyndzikau . That's why i took the action to fix quickly.
Nice catch by @ValeryShvyndzikau .

[ValeryShvyndzikau]

Hi @niko-achilles, no problem, thank you very much for your support and quick fix

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.