|
6 | 6 |
|
7 | 7 | ## Overview |
8 | 8 |
|
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. |
10 | 10 |
|
11 | 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` |
12 | 12 |
|
@@ -133,18 +133,18 @@ arn:aws:lambda:us-east-1:247286868737:layer:firetail-extension-x86_64-v1-1-0:1 |
133 | 133 |
|
134 | 134 | 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`. |
135 | 135 |
|
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`. |
137 | 137 |
|
138 | 138 | Find below a full list of the environment variables used by the FireTail Lambda Extension: |
139 | 139 |
|
140 | 140 | | Environment Variable | Default Value | Description | |
141 | 141 | | -------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------ | |
142 | 142 | | `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 | |
145 | 145 | | `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 | |
148 | 148 |
|
149 | 149 |
|
150 | 150 |
|
@@ -235,9 +235,9 @@ resource "aws_lambda_function" "extensions-demo-example-lambda-python" { |
235 | 235 |
|
236 | 236 | ## Legacy Mode |
237 | 237 |
|
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. |
239 | 239 |
|
240 | | - |
| 240 | + |
241 | 241 |
|
242 | 242 | | Supported Runtimes | Library | |
243 | 243 | | -------------------- | ------------------------------------------------------------ | |
|
0 commit comments