feat: add documentation website (#37)

* docs: add initial docs website * docs: correct max width from theme * docs: remove redundant options * docs: fix env var contents Signed-off-by: heitorlessa <[email protected]> * docs: enlarge trace graph Signed-off-by: heitorlessa <[email protected]> * docs: fix stale package.json Signed-off-by: heitorlessa <[email protected]> * docs: add offline support Signed-off-by: heitorlessa <[email protected]> * docs: generate sitemap for docs Signed-off-by: heitorlessa <[email protected]> * docs: use bold text for code to ease reading Signed-off-by: heitorlessa <[email protected]> * docs: add Logger section Signed-off-by: heitorlessa <[email protected]> * docs: fix spacing in Logger Signed-off-by: heitorlessa <[email protected]> * docs: add Metrics section Signed-off-by: heitorlessa <[email protected]> * fix: add comment in example for odd dimension Signed-off-by: heitorlessa <[email protected]> * docs: add Middleware factory section Signed-off-by: heitorlessa <[email protected]> * docs: add testing your code section Signed-off-by: heitorlessa <[email protected]> * docs: rearrange tenets section Signed-off-by: heitorlessa <[email protected]> * docs: add debug mode Signed-off-by: heitorlessa <[email protected]> * docs: add helpful resources Signed-off-by: heitorlessa <[email protected]> * docs: correct src title Signed-off-by: heitorlessa <[email protected]> * docs: fix svg logo Signed-off-by: heitorlessa <[email protected]> * docs: typo Signed-off-by: heitorlessa <[email protected]> * docs: capitalize resources Signed-off-by: heitorlessa <[email protected]> * docs: fix main logo height Signed-off-by: heitorlessa <[email protected]> * feat: build docs website workflow Signed-off-by: heitorlessa <[email protected]> * fix: remove gatsby CI action Signed-off-by: heitorlessa <[email protected]> * chore: debug CI Signed-off-by: heitorlessa <[email protected]> * fix: Make syntax Signed-off-by: heitorlessa <[email protected]> * chore: remove tmate debugging Signed-off-by: heitorlessa <[email protected]> * fix: assets prefix Signed-off-by: heitorlessa <[email protected]> * chore: debug build prefix Signed-off-by: heitorlessa <[email protected]> * fix: docs target Signed-off-by: heitorlessa <[email protected]> * fix: CI attempt 2345678903245 Signed-off-by: heitorlessa <[email protected]> * fix: content tree Signed-off-by: heitorlessa <[email protected]> * chore: debug mkdir utility Signed-off-by: heitorlessa <[email protected]> * fix: prefix assets Signed-off-by: heitorlessa <[email protected]> * fix: github actions mkdir outdated Signed-off-by: heitorlessa <[email protected]> * fix: gatsby build files take 3245678 Signed-off-by: heitorlessa <[email protected]> * chore: fix api path Signed-off-by: heitorlessa <[email protected]> * fix: correct github ref url Signed-off-by: heitorlessa <[email protected]> * fix: last fixes for repo url Signed-off-by: heitorlessa <[email protected]> * fix: remove DEBUG Signed-off-by: heitorlessa <[email protected]> * improv: fix footer resources Signed-off-by: heitorlessa <[email protected]> * improv: add local docs target Signed-off-by: heitorlessa <[email protected]> * improv: add annotation and metadata info Signed-off-by: heitorlessa <[email protected]> * chore: docs build on master only Signed-off-by: heitorlessa <[email protected]>
aws-powertools · May 27, 2020 · e51dd10 · e51dd10
1 parent 78aa7f8
commit e51dd10
Show file tree

Hide file tree

Showing 28 changed files with 21,600 additions and 10 deletions.
diff --git a/.github/workflows/python_docs.yml b/.github/workflows/python_docs.yml
@@ -17,12 +17,10 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: "3.8"
-      - name: Install dependencies
-        run: make dev
-      - name: build docs
-        run: make docs
-      - name: deploy docs
+      - name: Build docs website
+        run: make build-docs
+      - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/aws_lambda_powertools/
+          publish_dir: ./dist
diff --git a/.gitignore b/.gitignore
@@ -293,5 +293,10 @@ $RECYCLE.BIN/
 # Misc
 test_report
 wheelhouse
-docs
 /.idea/*
+*.html
+
+# Docs files
+docs/.cache/
+docs/public
+node_modules
diff --git a/Makefile b/Makefile
@@ -6,6 +6,9 @@ dev:
 	pip install --upgrade pip poetry
 	poetry install
 
+dev-docs:
+	cd docs && npm install
+
 format:
 	poetry run isort -rc .
 	poetry run black aws_lambda_powertools
@@ -25,10 +28,24 @@ pr: lint test security-baseline complexity-baseline
 build: pr
 	poetry run build
 
-docs: dev
-	poetry run pdoc --html --output-dir docs ./aws_lambda_powertools --force
+build-docs:
+	mkdir -p dist/api
+	@$(MAKE) build-docs-website
+	@$(MAKE) build-docs-api
+
+build-docs-api: dev
+	poetry run pdoc --html --output-dir dist/api/ ./aws_lambda_powertools --force
+	mv dist/api/aws_lambda_powertools/* dist/api/
+	rm -rf dist/api/aws_lambda_powertools
+
+build-docs-website: dev-docs
+	cd docs && npm run build
+	cp -R docs/public/* dist/
 
 docs-dev:
+	cd docs && npm run start
+
+docs-api-dev:
 	poetry run pdoc --http : aws_lambda_powertools
 
 security-baseline:

diff --git a/docs/.prettierignore b/docs/.prettierignore
@@ -0,0 +1,4 @@
+.cache
+package.json
+package-lock.json
+public
diff --git a/docs/.prettierrc b/docs/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "arrowParens": "avoid",
+  "semi": false
+}
diff --git a/docs/api/.gitkeep b/docs/api/.gitkeep
diff --git a/docs/content/core/logger.mdx b/docs/content/core/logger.mdx
@@ -0,0 +1,224 @@
+---
+title: Logger
+description: Core utility
+---
+
+import Note from "../../src/components/Note"
+
+Logger provides an opinionated logger with output structured as JSON.
+
+**Key features**
+
+* Capture key fields from Lambda context, cold start and structures logging output as JSON
+* Log Lambda event when instructed (disabled by default)
+    - Enable via `POWERTOOLS_LOGGER_LOG_EVENT="true"` or explicitly via decorator param
+* Log sampling enables DEBUG log level for a percentage of requests (disabled by default)
+    - Enable via `POWERTOOLS_LOGGER_SAMPLE_RATE=0.1`, ranges from 0 to 1, where 0.1 is 10% and 1 is 100%
+* Append additional keys to structured log at any point in time
+
+## Initialization
+
+Set `LOG_LEVEL` env var as a start - Here is an example using AWS Serverless Application Model (SAM)
+
+```yaml:title=template.yaml
+Resources:
+    HelloWorldFunction:
+        Type: AWS::Serverless::Function
+        Properties:
+        ...
+        Runtime: python3.8
+        Environment:
+            Variables:
+                LOG_LEVEL: INFO # highlight-line
+```
+
+By default, Logger uses **INFO** log level. You can either change log level via `level` param or via env var.
+
+You can also explicitly set a service name via `service` param or via `POWERTOOLS_SERVICE_NAME` env var. This sets **service** key that will be present across all log statements.
+
+```python:title=app.py
+from aws_lambda_powertools.logging import Logger
+# POWERTOOLS_SERVICE_NAME defined
+logger = Logger() # highlight-line 
+
+# Explicit definition
+Logger(service="payment", level="INFO")
+```
+
+## Standard structured keys
+
+Your Logger will always include the following keys to your structured logging:
+
+Key | Type | Example | Description
+------------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------
+**timestamp** | str | "2020-05-24 18:17:33,774" | Timestamp of actual log statement
+**level** | str | "INFO" | Logging level
+**location** | str | "collect.handler:1" | Source code location where statement was executed
+**service** | str | "payment" | Service name defined. "service_undefined" will be used if unknown
+**sampling_rate** | int |  0.1 | Debug logging sampling rate in percentage e.g. 1% in this case
+**message** | any |  "Collecting payment" | Log statement value. Unserializable JSON values will be casted to string
+
+## Capturing context Lambda info 
+
+You can enrich your structured logs with key Lambda context information via `inject_lambda_context`.
+
+```python:title=collect.py
+from aws_lambda_powertools.logging import Logger
+
+logger = Logger()
+
+@logger.inject_lambda_context
+def handler(event, context)
+  logger.info("Collecting payment")
+  ...
+  # You can log entire objects too
+  logger.info({
+    "operation": "collect_payment",
+    "charge_id": event['charge_id']
+  })
+  ...
+```
+
+You can also explicitly log any incoming event using `log_event` param or via `POWERTOOLS_LOGGER_LOG_EVENT` env var.
+
+<Note type="warning">
+  This is disabled by default to prevent sensitive info being logged.
+</Note><br/>
+
+```python:title=log_handler_event.py
+from aws_lambda_powertools.logging import Logger
+
+logger = Logger()
+
+@logger.inject_lambda_context(log_event=True) # highlight-start
+def handler(event, context)
+  ...
+```
+
+When used, this will include the following keys:
+
+Key | Type | Example
+------------------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------
+**cold_start**| bool | false
+**function_name**| str | "example-powertools-HelloWorldFunction-1P1Z6B39FLU73"
+**function_memory_size**| int | 128
+**function_arn**| str | "arn:aws:lambda:eu-west-1:012345678910:function:example-powertools-HelloWorldFunction-1P1Z6B39FLU73"
+**function_request_id**| str | "899856cb-83d1-40d7-8611-9e78f15f32f4"
+
+<details>
+<summary><strong>Exerpt output in CloudWatch Logs</strong></summary>
+
+```json:title=cloudwatch_logs.json
+{  
+   "timestamp":"2020-05-24 18:17:33,774",
+   "level":"INFO",
+   "location":"collect.handler:1",
+   "service":"payment",
+// highlight-start
+   "lambda_function_name":"test",
+   "lambda_function_memory_size": 128,
+   "lambda_function_arn":"arn:aws:lambda:eu-west-1:12345678910:function:test",
+   "lambda_request_id":"52fdfc07-2182-154f-163f-5f0f9a621d72",
+   "cold_start": true,
+// highlight-end
+   "sampling_rate": 0.0,
+   "message": "Collecting payment"
+}
+
+{  
+   "timestamp":"2020-05-24 18:17:33,774",
+   "level":"INFO",
+   "location":"collect.handler:15",
+   "service":"payment",
+   "lambda_function_name":"test",
+   "lambda_function_memory_size": 128,
+   "lambda_function_arn":"arn:aws:lambda:eu-west-1:12345678910:function:test",
+   "lambda_request_id":"52fdfc07-2182-154f-163f-5f0f9a621d72",
+   "cold_start": true,
+   "sampling_rate": 0.0,
+// highlight-start
+   "message":{  
+      "operation":"collect_payment",
+      "charge_id": "ch_AZFlk2345C0"
+   }
+// highlight-end
+}
+```
+</details>
+
+## Appending additional keys
+
+You can append your own keys to your existing Logger via `structure_logs` with **append** param. 
+
+```python:title=collect.py
+from aws_lambda_powertools.logging import Logger
+
+logger = Logger()
+
+def handler(event, context)
+  if "order_id" in event:
+      logger.structure_logs(append=True, order_id=event["order_id"]) # highlight-line
+      logger.info("Collecting payment")
+      ...
+```
+
+<details>
+<summary><strong>Exerpt output in CloudWatch Logs</strong></summary>
+
+```json:title=cloudwatch_logs.jsonn
+{  
+   "timestamp": "2020-05-24 18:17:33,774",
+   "level": "INFO",
+   "location": "collect.handler:1",
+   "service": "payment",
+   "lambda_function_name": "test",
+   "lambda_function_memory_size": 128,
+   "lambda_function_arn": "arn:aws:lambda:eu-west-1:12345678910:function:test",
+   "lambda_request_id": "52fdfc07-2182-154f-163f-5f0f9a621d72",
+   "cold_start": true,
+   "sampling_rate": 0.0,
+   "order_id": "order_id_value", // highlight-line
+   "message": "Collecting payment"
+}
+```
+</details>
+
+## Sampling debug logs
+
+You can dynamically set a percentage of your logs to **DEBUG** level using `sample_rate` param or via env var `POWERTOOLS_LOGGER_SAMPLE_RATE`.
+
+<Note type="warning">
+  This is possible due to <a href="https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html">AWS Lambda reuse of execution context</a>, <strong>however, it is not always guaranteed.</strong>
+</Note><br/>
+
+```python:title=collect.py
+from aws_lambda_powertools.logging import Logger
+
+# Sample 1% of debug logs e.g. 0.1
+logger = Logger(sample_rate=0.1) # highlight-line
+
+def handler(event, context)
+  if "order_id" in event:
+      logger.info("Collecting payment")
+      ...
+```
+
+<details>
+<summary><strong>Exerpt output in CloudWatch Logs</strong></summary>
+
+```json:title=cloudwatch_logs.json
+{  
+   "timestamp": "2020-05-24 18:17:33,774",
+   "level": "INFO",
+   "location": "collect.handler:1",
+   "service": "payment",
+   "lambda_function_name": "test",
+   "lambda_function_memory_size": 128,
+   "lambda_function_arn": "arn:aws:lambda:eu-west-1:12345678910:function:test",
+   "lambda_request_id": "52fdfc07-2182-154f-163f-5f0f9a621d72",
+   "cold_start": true,
+   "sampling_rate": 0.1, // highlight-line
+   "message": "Collecting payment"
+}
+```
+</details>