Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rename project to Powertools for AWS Lambda (.NET) #282

Merged
merged 1 commit into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ body:
- type: input
id: version
attributes:
label: AWS Lambda Powertools for .NET version
label: Powertools for AWS Lambda (.NET) version
placeholder: "latest, 1.25.6"
value: latest
validations:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Feature request
description: Suggest an idea for Lambda Powertools
description: Suggest an idea for Powertools for AWS Lambda (.NET)
title: "Feature request: TITLE"
labels: ["feature-request", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest an idea to the Lambda Powertools project.
Thank you for taking the time to suggest an idea to the Powertools for AWS Lambda (.NET) project.

*Future readers*: Please react with 👍 and your use case to help us understand customer demand.
- type: textarea
Expand Down Expand Up @@ -36,9 +36,9 @@ body:
attributes:
label: Acknowledgment
options:
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/tenets)
- label: This feature request meets [Powertools for AWS Lambda (.NET) Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/tenets)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
required: false
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/maintenance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ body:
attributes:
label: Acknowledgment
options:
- label: This request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/latest/#tenets)
- label: This request meets [Powertools for AWS Lambda (.NET) Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/latest/#tenets)
required: true
- type: markdown
attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
- type: dropdown
id: area
attributes:
label: Which AWS Lambda Powertools utility does this relate to?
label: Which Powertools for AWS Lambda (.NET) utility does this relate to?
options:
- Tracing
- Logging
Expand Down Expand Up @@ -79,9 +79,9 @@ body:
attributes:
label: Acknowledgment
options:
- label: This feature request meets [Lambda Powertools Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/tenets/)
- label: This feature request meets [Powertools for AWS Lambda (.NET) Tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/tenets/)
required: true
- label: Should this be considered in other Lambda Powertools languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
- label: Should this be considered in other Powertools for AWS Lambda (.NET) languages? i.e. [Python](https://github.com/awslabs/aws-lambda-powertools-python), [Java](https://github.com/awslabs/aws-lambda-powertools-java/), and [TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript/)
required: false
- type: markdown
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/share_your_work.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: I Made This (showcase your work)
description: Share what you did with Powertools 💞💞. Blog post, workshops, presentation, sample apps, etc.
description: Share what you did with Powertools for AWS Lambda (.NET) 💞💞. Blog post, workshops, presentation, sample apps, etc.
title: "[I Made This]: <TITLE>"
labels: ["community-content"]
body:
Expand All @@ -13,7 +13,7 @@ body:
description: |
Please share the original link to your material.

*Note: Short links will be expanded when added to Powertools documentation*
*Note: Short links will be expanded when added to Powertools for AWS Lambda (.NET) documentation*
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -44,13 +44,13 @@ body:
description: |
Any notes you might want to share with us related to this material.

*Note: These notes are explicitly to Powertools maintainers. It will not be added to the community resources page.*
*Note: These notes are explicitly to Powertools for AWS Lambda (.NET) maintainers. It will not be added to the community resources page.*
validations:
required: false
- type: checkboxes
id: acknowledgment
attributes:
label: Acknowledgment
options:
- label: I understand this content may be removed from Powertools documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
- label: I understand this content may be removed from Powertools for AWS Lambda (.NET) documentation if it doesn't conform with the [Code of Conduct](https://aws.github.io/code-of-conduct)
required: true
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/support_powertools.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Support Lambda Powertools (become a reference)
description: Add your organization's name or logo to the Lambda Powertools documentation
title: "[Support Lambda Powertools]: <your organization name>"
name: Support Powertools for AWS Lambda (.NET) (become a reference)
description: Add your organization's name or logo to the Powertools for AWS Lambda (.NET) documentation
title: "[Support Powertools for AWS Lambda (.NET)]: <your organization name>"
labels: ["customer-reference"]
body:
- type: markdown
Expand Down Expand Up @@ -42,13 +42,13 @@ body:
id: use_case
attributes:
label: (Optional) Use case
description: How are you using Lambda Powertools today? *features, etc.*
description: How are you using Powertools for AWS Lambda (.NET) today? *features, etc.*
validations:
required: false
- type: checkboxes
id: other_languages
attributes:
label: Also using other Lambda Powertools languages?
label: Also using other Powertools for AWS Lambda (.NET) languages?
options:
- label: Python
required: false
Expand All @@ -59,6 +59,6 @@ body:
- type: markdown
attributes:
value: |
*By raising a Support Lambda Powertools issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.*
*By raising a Support Powertools for AWS Lambda (.NET) issue, you are granting AWS permission to use your company's name (and/or logo) for the limited purpose described here. You are also confirming that you have authority to grant such permission.*

*You can opt-out at any time by commenting or reopening this issue.*
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
## [1.1.0] - 2023-05-05
## Maintenance

* add Lambda Powertools for Python in issue templates
* add Lambda Powertools for AWS Lambda (Python) in issue templates
* add workflow to dispatch analytics fetching
* **ci:** add workflow to dispatch analytics fetching

Expand Down Expand Up @@ -76,7 +76,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline

## Documentation

* **home:** update powertools definition
* **home:** update Powertools for AWS Lambda (.NET) definition

## Maintenance

Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ These are the most common labels used by maintainers to triage issues, pull requ
| breaking-change | Changes that will cause customer impact and need careful triage | |
| do-not-merge | PRs that are blocked for varying reasons | Timeline is uncertain |
| tests | PRs that add or change tests | PR automation |
| `area/<utility>` | PRs related to a Powertools utility, e.g. `logging`, `tracing` | PR automation |
| `area/<utility>` | PRs related to a Powertools for AWS Lambda (.NET) utility, e.g. `logging`, `tracing` | PR automation |
| feature | New features or minor changes | PR/Release automation |
| dependencies | Changes that touch dependencies, e.g. Dependabot, etc. | PR/ automation |
| github-actions | Changes in GitHub workflows | PR automation |
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# AWS Lambda Powertools for .NET
# Powertools for AWS Lambda (.NET)

![aws provider](https://img.shields.io/badge/provider-AWS-orange?logo=amazon-aws&color=ff9900)
[![Build](https://github.com/awslabs/aws-lambda-powertools-dotnet/actions/workflows/build.yml/badge.svg?branch=develop)](https://github.com/awslabs/aws-lambda-powertools-dotnet/actions/workflows/build.yml)
[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET)

Powertools is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-dotnet/#features).
Powertools for AWS Lambda (.NET) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://awslabs.github.io/aws-lambda-powertools-dotnet/#features).

**[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-dotnet/)** | **[NuGet](https://www.nuget.org/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](#examples)**

> **Join us on the AWS Developers Slack at `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-gu30gquv-EhwIYq3kHhhysaZ2aIX7ew)**

## Features

Lambda Powertools provides three core utilities:
Powertools for AWS Lambda (.NET) provides three core utilities:

* **[Logging](https://awslabs.github.io/aws-lambda-powertools-dotnet/core/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.

Expand All @@ -24,7 +24,7 @@ Lambda Powertools provides three core utilities:

### Installation

The AWS Lambda Powertools for .NET utilities (.NET 6) are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.
The Powertools for AWS Lambda (.NET) utilities (.NET 6) are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.

* [AWS.Lambda.Powertools.Logging](https://www.nuget.org/packages?q=AWS.Lambda.Powertools.Logging):

Expand All @@ -50,18 +50,18 @@ We have provided examples focused specifically on each of the utilities. Each so
* **[Metrics example](examples/Metrics/)**
* **[Tracing example](examples/Tracing/)**

## Other members of the AWS Lambda Powertools family
## Other members of the Powertools for AWS Lambda family

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

* [AWS Lambda Powertools for Python](https://github.com/awslabs/aws-lambda-powertools-python)
* [AWS Lambda Powertools for Java](https://github.com/awslabs/aws-lambda-powertools-java)
* [AWS Lambda Powertools for TypeScript](https://github.com/awslabs/aws-lambda-powertools-typescript)
* [Powertools for AWS Lambda (Python)](https://github.com/awslabs/aws-lambda-powertools-python)
* [Powertools for AWS Lambda (Java)](https://github.com/awslabs/aws-lambda-powertools-java)
* [Powertools for AWS Lambda (TypeScript)](https://github.com/awslabs/aws-lambda-powertools-typescript)

## Credits

* Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)
* Powertools idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)
* Powertools for AWS Lambda (.NET) idea [DAZN Powertools](https://github.com/getndazn/dazn-lambda-powertools/)

## 👋 Contributing

Expand All @@ -71,7 +71,7 @@ We welcome contributions from developers of all levels to our open-source projec

## Connect

* **AWS Lambda Powertools on Discord**: `#dotnet` - **[Invite link](https://discord.gg/B8zZKbbyET)**
* **Powertools for AWS Lambda on Discord**: `#dotnet` - **[Invite link](https://discord.gg/B8zZKbbyET)**
* **Email**: <aws-lambda-powertools-feedback@amazon.com>

## License
Expand Down
4 changes: 2 additions & 2 deletions apidocs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@
"dest": "_site",
"globalMetadataFiles": [],
"globalMetadata": {
"_appTitle": "AWS Lambda Powertools for .NET",
"_appTitle": "Powertools for AWS Lambda (.NET)",
"_appFaviconPath": "images/favicon.ico",
"_appLogoPath": "images/img.svg",
"_enableNewTab": true,
"_disableContribution": true,
"_enableSearch": "true",
"_appFooter": "AWS Lambda Powertools for .NET API Documentation"
"_appFooter": "Powertools for AWS Lambda (.NET) API Documentation"
},
"fileMetadataFiles": [],
"template": ["default", "templates/material"],
Expand Down
8 changes: 4 additions & 4 deletions apidocs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# AWS Lambda Powertools for .NET API
# Powertools for AWS Lambda (.NET) API

Welcome to the **AWS Lambda Powertools for .NET API** reference. This documentation contains the API details for all supported utilities.
Welcome to the **Powertools for AWS Lambda (.NET) API** reference. This documentation contains the API details for all supported utilities.

To get started use the `API Documentaion` menu on the navigation bar, or search for specific keywords on the search box on top-right corner of your screen.

> [!NOTE]
> Are you looking for documentation on how to use AWS Lambda Powertools for .NET utilities and code samples?
> Are you looking for documentation on how to use Powertools for AWS Lambda (.NET) utilities and code samples?
>
> 👉 [Here](https://awslabs.github.io/aws-lambda-powertools-dotnet/) is the perfect place to start.

## Feedback

If you have any feedback, create a new issue in the *AWS Lambda Powertools for .NET* repository on [GitHub](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues).
If you have any feedback, create a new issue in the *Powertools for AWS Lambda (.NET)* repository on [GitHub](https://github.com/awslabs/aws-lambda-powertools-dotnet/issues).
2 changes: 1 addition & 1 deletion apidocs/toc.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- name: API Documentation
href: api/
homepage: api/index.md
- name: AWS Lambda Powertools for .NET Documentation
- name: Powertools for AWS Lambda (.NET) Documentation
href: "https://awslabs.github.io/aws-lambda-powertools-dotnet/"
8 changes: 4 additions & 4 deletions docs/core/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The logging utility provides a Lambda optimized logger with output structured as

## Installation

Powertools are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.
Powertools for AWS Lambda (.NET) are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.

* [AWS.Lambda.Powertools.Logging](https://www.nuget.org/packages?q=AWS.Lambda.Powertools.Logging):

Expand Down Expand Up @@ -45,7 +45,7 @@ Here is an example using the AWS SAM [Globals section](https://docs.aws.amazon.c
AWSTemplateFormatVersion: "2010-09-09"
Transform: AWS::Serverless-2016-10-31
Description: >
Example project for Powertools Logging utility
Example project for Powertools for AWS Lambda (.NET) Logging utility

Globals:
Function:
Expand Down Expand Up @@ -77,7 +77,7 @@ Key | Type | Example | Description
------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------
**Timestamp** | string | "2020-05-24 18:17:33,774" | Timestamp of actual log statement
**Level** | string | "Information" | Logging level
**Name** | string | "Powertools Logger" | Logger name
**Name** | string | "Powertools for AWS Lambda (.NET) Logger" | Logger name
**ColdStart** | bool | true| ColdStart value.
**Service** | string | "payment" | Service name defined. "service_undefined" will be used if unknown
**SamplingRate** | int | 0.1 | Debug logging sampling rate in percentage e.g. 10% in this case
Expand Down Expand Up @@ -445,7 +445,7 @@ via `SamplingRate` parameter on attribute.

## Configure Log Output Casing

By definition Powertools outputs logging keys using **snake case** (e.g. *"function_memory_size": 128*). This allows developers using different Powertools runtimes, to search logs across services written in languages such as Python or TypeScript.
By definition Powertools for AWS Lambda (.NET) outputs logging keys using **snake case** (e.g. *"function_memory_size": 128*). This allows developers using different Powertools for AWS Lambda (.NET) runtimes, to search logs across services written in languages such as Python or TypeScript.

If you want to override the default behavior you can either set the desired casing through attributes, as described in the example below, or by setting the `POWERTOOLS_LOGGER_CASE` environment variable on your AWS Lambda function. Allowed values are: `CamelCase`, `PascalCase` and `SnakeCase`.

Expand Down
2 changes: 1 addition & 1 deletion docs/core/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ These metrics can be visualized through [Amazon CloudWatch Console](https://aws.

## Installation

Powertools are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.
Powertools for AWS Lambda (.NET) are available as NuGet packages. You can install the packages from [NuGet Gallery](https://www.nuget.org/packages?q=AWS+Lambda+Powertools*){target="_blank"} or from Visual Studio editor by searching `AWS.Lambda.Powertools*` to see various utilities available.

* [AWS.Lambda.Powertools.Metrics](https://www.nuget.org/packages?q=AWS.Lambda.Powertools.Metrics):

Expand Down
Loading