jakejscott/aws-lambda-powertools-dotnet

A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier.

AWS Lambda Powertools for .NET

AWS Lambda Powertools for .NET (C#) is suite of utilities for AWS Lambda functions to simplify implementation of serverless observability best practices such as tracing, structured logging, custom metrics.

📜 Documentation | NuGet | Roadmap | Examples

Join us on the AWS Developers Slack at #lambda-powertools - Invite, if you don't have an account

Features

Lambda Powertools provides three core utilities:

• Logging - provides a custom logger class that outputs structured JSON. It allows you to pass in strings or more complex objects, and will take care of serializing the log output. Common use cases—such as logging the Lambda event payload and capturing cold start information—are handled for you, including appending custom keys to the logger at anytime.

• Metrics - makes collecting custom metrics from your application simple, without the need to make synchronous requests to external systems. This functionality is powered by Amazon CloudWatch Embedded Metric Format (EMF), which allows for capturing metrics asynchronously.

• Tracing - provides a simple way to send traces from functions to AWS X-Ray to provide visibility into function calls, interactions with other AWS services, or external HTTP requests. Annotations easily can be added to traces to allow filtering traces based on key information. For example, when using Tracer, a ColdStart annotation is created for you, so you can easily group and analyze traces where there was an initialization overhead.

Installation

The AWS Lambda Powertools for .NET utilities (.NET 6) are available as NuGet packages. You can install the packages from NuGet gallery or from Visual Studio editor. Search AWS.Lambda.Powertools* to see various utilities available.Powertools is available on NuGet.

• AWS.Lambda.Powertools.Logging:

  dotnet add package AWS.Lambda.Powertools.Logging

• AWS.Lambda.Powertools.Metrics:

  dotnet add package AWS.Lambda.Powertools.Metrics

• AWS.Lambda.Powertools.Tracing:

  dotnet add package AWS.Lambda.Powertools.Tracing

Examples

We have provided examples focused specifically on each of the utilities. Each solution comes with AWS Serverless Application Model (AWS SAM) templates to run your functions as Zip package using the AWS Lambda .NET 6 managed runtime, or as a container package using the AWS base images for .NET.

• Logging example
• Metrics example
• Tracing example

Other members of the AWS Lambda Powertools family

Not using .NET? No problem we have you covered. Here are the other members of the AWS Lambda Powertools family:

• AWS Lambda Powertools for Python
• AWS Lambda Powertools for Java
• AWS Lambda Powertools for TypeScript

Credits

• Structured logging initial implementation from aws-lambda-logging
• Powertools idea DAZN Powertools

Connect

• AWS Developers Slack: #lambda-powertools - Invite, if you don't have an account
• Email: [email protected]

License

This project is licensed under the Apache-2.0 License.