Skip to content

Commit 73428c0

Browse files
committed
Document env vars
1 parent f4ab289 commit 73428c0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,16 @@ For example, for `ARCH=arm64` and `VERSION=v1-0-0` this should yield:
141141
arn:aws:lambda:us-east-1:247286868737:layer:firetail-extension-x86_64-v1-0-4:1
142142
```
143143

144+
Regardless of how you add the Lambda Layer to your Lambda Function, you will also need to configure at least one environment variable: `FIRETAIL_API_TOKEN`. Find below a full list of the environment variables used by the Firetail Lambda Extension:
145+
146+
| Environment Variable | Default Value | Description |
147+
| ------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
148+
| 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 |
149+
| FIRETAIL_API_URL | `https://api.logging.eu-west-1.prod.firetail.app/logs/bulk` | The URL of the Firetail Logging API |
150+
| 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) |
151+
| FIRETAIL_LOG_BUFFER_SIZE | `1000` | The maximum amount of logs the extension will hold in its buffer before being batched and sent to Firetail |
152+
| FIRETAIL_MAX_BATCH_SIZE | `100` | The maximum size of a batch of logs to be sent to the Firetail logging API in one request |
153+
144154

145155

146156
#### Using The AWS CLI

0 commit comments

Comments
 (0)