https://github.com/firetail-io/firetail-py-lambda
Firetail Python Lambda Middleware
https://github.com/firetail-io/firetail-py-lambda
Last synced: 3 months ago
JSON representation
Firetail Python Lambda Middleware
- Host: GitHub
- URL: https://github.com/firetail-io/firetail-py-lambda
- Owner: FireTail-io
- License: other
- Created: 2022-11-09T16:22:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-24T08:29:57.000Z (almost 2 years ago)
- Last Synced: 2025-04-14T23:44:05.070Z (3 months ago)
- Language: Python
- Size: 48.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FireTail Python Lambda Middleware
[](https://pypi.org/project/firetail-lambda/) [](https://github.com/Firetail-io/firetail-py-lambda/releases) [](https://github.com/Firetail-io/firetail-py-lambda/actions) [](https://www.gnu.org/licenses/lgpl-3.0) [](https://codecov.io/gh/FireTail-io/firetail-py-lambda)
### Overview
The purpose of this module is to correctly log out the AWS Lambda event and response payload to allow the firetail extension to then send it on to the FireTail logging API.
The firetail_handler is a decorator that wraps around an event handler function in a AWS Lambda to extract the event and response payloads into a base64 logging message.
### Supported Lambda Runtimes
✅ Python 3.7
✅ Python 3.8
✅ Python 3.9
✅ Python 3.10
### Installation
Install the module using pip:
```bash
pip install -U firetail-lambda
```
Implementing Middleware in lambda function:
```python
import json
from firetail_lambda import firetail_handler, firetail_app
app = firetail_app()
@firetail_handler(app)
def lambda_handler(event, context):
return {
"statusCode": 200,
"body": json.dumps({
"message": "Hello"
})
}
```
Multiple Event handlers:
```python
import json
from firetail_lambda import firetail_handler, firetail_app
app = firetail_app()
@firetail_handler(app)
def lambda_handler(event, context):
return {
"statusCode": 200,
"body": json.dumps({
"message": "Hello"
})
}
@firetail_handler(app)
def lambda_handler_2(event, context):
return {
"statusCode": 200,
"body": json.dumps({
"message": "Hello 2"
})
}
```
Custom Sanitization callback:
```python
import copy
import json
from firetail_lambda import firetail_handler, firetail_app
def sanitize_payloads(event, response):
new_event = copy.copy(event)
remove_headers = ['authorization','Authorization', 'x-api-key']
if 'headers' in event:
for header in remove_headers:
if header in event['headers']:
del new_event['headers'][header]
if 'multiValueHeaders' in event and header in event['multiValueHeaders']:
del new_event['multiValueHeaders'][header]
return new_event, response
app = firetail_app()
app.sanitization_callback = sanitize_payloads
@firetail_handler(app)
def lambda_handler(event, context):
return {
"statusCode": 200,
"body": json.dumps({
"message": "Hello"
})
}
```