Skip to content

Commit dab8dd0

Browse files
committed
Update docs to explain how the new proxy approach works
1 parent c58c033 commit dab8dd0

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22

33
[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0) [![Test and coverage](https://github.com/FireTail-io/firetail-lambda-extension/actions/workflows/codecov.yml/badge.svg?branch=defaults)](https://github.com/FireTail-io/firetail-lambda-extension/actions/workflows/codecov.yml) [![codecov](https://codecov.io/gh/FireTail-io/firetail-lambda-extension/branch/main/graph/badge.svg?token=QNWMOGA31B)](https://codecov.io/gh/FireTail-io/firetail-lambda-extension)
44

5+
The FireTail Lambda Extension collects AWS Lambda events and response payloads by proxying the Lambda Runtime API and sending them to the FireTail Logging API.
6+
7+
**No code changes are required!** Simply add the FireTail Lambda Extension as a Lambda Layer and configure a few environment variables.
8+
59

610

711
## Overview
812

9-
The FireTail Logging Extension collects AWS Lambda events & response payloads by proxying the Lambda runtime API and sends them to the FireTail Logging API.
13+
A wrapper script, [firetail-wrapper.sh](./firetail-wrapper.sh), is included in the FireTail Lambda Extension's ZIP file. You must use this script by setting the `AWS_LAMBDA_EXEC_WRAPPER` environment variable to `/opt/firetail-wrapper.sh`.
14+
15+
The wrapper script sets the `AWS_LAMBDA_RUNTIME_API` environment variable to point to a proxy API provided by the FireTail Lambda Extension. This extension captures:
16+
17+
- The response from the Lambda Runtime API in `GET /2018-06-01/runtime/invocation/next` calls, which includes the event that triggered your Lambda function.
18+
- The request made by the Lambda Runtime in `POST /2018-06-01/runtime/invocation/{requestId}/response` calls, which includes the response your Lambda function provided to the triggering event.
1019

11-
Includes a wrapper script, [firetail-wrapper.sh](./firetail-wrapper.sh), that you must use by setting the `AWS_LAMBDA_EXEC_WRAPPER` to `/opt/firetail-wrapper.sh`
20+
![FireTail Lambda Extension Lifecycle Diagram](./docs/imgs/extension-lifecycle-proxy.svg)
1221

1322

1423

docs/imgs/extension-lifecycle-proxy.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)