Skip to content

Commit 07095e1

Browse files
committed
update docs
1 parent 8a74255 commit 07095e1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Overview
88

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

1111
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`
1212

@@ -133,18 +133,18 @@ arn:aws:lambda:us-east-1:247286868737:layer:firetail-extension-x86_64-v1-1-0:1
133133

134134
Regardless of how you add the Lambda Layer to your Lambda Function, you will also need to configure at least two environment variables: `AWS_LAMBDA_EXEC_WRAPPER` and `FIRETAIL_API_TOKEN`.
135135

136-
If you are using not using the Firetail SaaS' default region then you will also need to set the environment variable `FIRETAIL_API_URL` appropriately. For example, for `us.firetail.app` the appropriate URL would be `https://api.logging.us-east-2.prod.firetail.app/logs/bulk`.
136+
If you are using not using the FireTail SaaS' default region then you will also need to set the environment variable `FIRETAIL_API_URL` appropriately. For example, for `us.firetail.app` the appropriate URL would be `https://api.logging.us-east-2.prod.firetail.app/logs/bulk`.
137137

138138
Find below a full list of the environment variables used by the FireTail Lambda Extension:
139139

140140
| Environment Variable | Default Value | Description |
141141
| -------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------ |
142142
| `AWS_LAMBDA_EXEC_WRAPPER` | None | Must be set to `/opt/firetail-wrapper.sh`. |
143-
| `FIRETAIL_API_TOKEN` | None | Your API token for the Firetail Logging API. If left unset, no logs will be sent to the Firetail Logging API |
144-
| `FIRETAIL_API_URL` | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk` | The URL of the Firetail Logging API |
143+
| `FIRETAIL_API_TOKEN` | None | Your API token for the FireTail Logging API. If left unset, no logs will be sent to the FireTail Logging API |
144+
| `FIRETAIL_API_URL` | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk` | The URL of the FireTail Logging API |
145145
| `FIRETAIL_EXTENSION_DEBUG` | `false` | Enables debug logging from the extension if set to a value parsed as `true` by [strconv.ParseBool](https://pkg.go.dev/strconv#ParseBool) |
146-
| `FIRETAIL_LOG_BUFFER_SIZE` | `1000` | The maximum amount of logs the extension will hold in its buffer from which logs are batched and sent to Firetail |
147-
| `FIRETAIL_MAX_BATCH_SIZE` | `100` | The maximum size of a batch of logs to be sent to the Firetail logging API in one request |
146+
| `FIRETAIL_LOG_BUFFER_SIZE` | `1000` | The maximum amount of logs the extension will hold in its buffer from which logs are batched and sent to FireTail |
147+
| `FIRETAIL_MAX_BATCH_SIZE` | `100` | The maximum size of a batch of logs to be sent to the FireTail logging API in one request |
148148

149149

150150

@@ -235,9 +235,9 @@ resource "aws_lambda_function" "extensions-demo-example-lambda-python" {
235235

236236
## Legacy Mode
237237

238-
The FireTail Lambda extension used to work in conjunction with a runtime-specific Firetail library which you would need to use in your Function code. The Firetail library outputted specifically formatted logs which the extension then received via the [Lambda Logs API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html). You can find a table of Firetail function libraries which correspond with a Lambda runtime in the table below. Below is a diagram depicting how the Firetail extension, Extensions API, Logs API and Firetail API interact over the lifetime of a Lambda.
238+
The FireTail Lambda extension used to work in conjunction with a runtime-specific FireTail library which you would need to use in your Function code. The FireTail library outputted specifically formatted logs which the extension then received via the [Lambda Logs API](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-logs-api.html). You can find a table of FireTail function libraries which correspond with a Lambda runtime in the table below. Below is a diagram depicting how the FireTail extension, Extensions API, Logs API and FireTail API interact over the lifetime of a Lambda.
239239

240-
![Firetail Lambda Extension Lifecycle Diagram](./docs/imgs/extension-lifecycle.svg)
240+
![FireTail Lambda Extension Lifecycle Diagram](./docs/imgs/extension-lifecycle.svg)
241241

242242
| Supported Runtimes | Library |
243243
| -------------------- | ------------------------------------------------------------ |

0 commit comments

Comments
 (0)