Skip to content
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
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,22 @@

[![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)

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.

**No code changes are required!** Simply add the FireTail Lambda Extension as a Lambda Layer and configure a few environment variables.



## Overview

The FireTail Logging Extension collects AWS Lambda events & response payloads by proxying the Lambda runtime API and sends them to the FireTail Logging API.
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`.

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:

- 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.
- 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.

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`
![FireTail Lambda Extension Lifecycle Diagram](./docs/imgs/extension-lifecycle-proxy.svg)



Expand Down
1 change: 1 addition & 0 deletions docs/imgs/extension-lifecycle-proxy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.