You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/index.mdx
+12-12
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Powertools is a suite of utilities for AWS Lambda Functions that makes tracing w
10
10
<Notetype="info">
11
11
<strong>Looking for a quick run through of the core utilities?</strong><br/><br/>
12
12
Check out <ahref="https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/">this detailed blog post</a> with a practical example.
13
-
</Note><br/>
13
+
</Note>
14
14
15
15
## Install
16
16
@@ -34,17 +34,6 @@ Utility | Description
34
34
[Bring your own middleware](.//utilities/middleware_factory) | Decorator factory to create your own middleware to run logic before, and after each Lambda invocation
35
35
[Parameters utility](./utilities/parameters) | Retrieve parameter values from AWS Systems Manager Parameter Store, AWS Secrets Manager, or Amazon DynamoDB, and cache them for a specific amount of time
36
36
37
-
## Tenets
38
-
39
-
***AWS Lambda only** – We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
40
-
***Eases the adoption of best practices** – The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.
41
-
***Keep it lean** – Additional dependencies are carefully considered for security and ease of maintenance, and prevent negatively impacting startup time.
42
-
***We strive for backwards compatibility** – New features and changes should keep backwards compatibility. If a breaking change cannot be avoided, the deprecation and migration process should be clearly defined.
43
-
***We work backwards from the community** – We aim to strike a balance of what would work best for 80% of customers. Emerging practices are considered and discussed via Requests for Comment (RFCs)
44
-
***Idiomatic** – Utilities follow programming language idioms and language-specific best practices.
45
-
46
-
_`*` Core utilities are Tracer, Logger and Metrics. Optional utilities may vary across languages._
47
-
48
37
## Environment variables
49
38
50
39
**Environment variables** used across suite of utilities.
@@ -68,3 +57,14 @@ from aws_lambda_powertools.logging.logger import set_package_logger
68
57
69
58
set_package_logger()
70
59
```
60
+
61
+
## Tenets
62
+
63
+
***AWS Lambda only** – We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
64
+
***Eases the adoption of best practices** – The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.
65
+
***Keep it lean** – Additional dependencies are carefully considered for security and ease of maintenance, and prevent negatively impacting startup time.
66
+
***We strive for backwards compatibility** – New features and changes should keep backwards compatibility. If a breaking change cannot be avoided, the deprecation and migration process should be clearly defined.
67
+
***We work backwards from the community** – We aim to strike a balance of what would work best for 80% of customers. Emerging practices are considered and discussed via Requests for Comment (RFCs)
68
+
***Idiomatic** – Utilities follow programming language idioms and language-specific best practices.
69
+
70
+
_`*` Core utilities are Tracer, Logger and Metrics. Optional utilities may vary across languages._
0 commit comments