Skip to content

Commit

Permalink
added default and some descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
hrai-nr committed Nov 14, 2024
1 parent 93612a3 commit 9bf2300
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,20 @@ To try this integration out you can use the `sam` cli to deploy the cloudformati
#### CloudFormation Parameters

- `NewRelicRegion` : Can either be `US` or `EU` depending on which endpoint to be used to push logs to New Relic
- For this param `US` is default
- `LicenseKey`: Used when forwarding logs to New Relic
- `LogGroupConfig` : String representation of JSON array of objects of your CloudWatch LogGroup(s) and respective filter (if applicable) to set the Lambda function trigger.
- Example : ```[{"LogGroupName":"group1"}, {"LogGroupName":"group2", "FilterPattern":"ERROR"}, {"LogGroupName":"group3", "FilterPattern":"INFO"}]```
- `LoggingFirehoseStreamName` : Name of new Data Firehose Delivery Stream (must be unique per AWS account in the same AWS Region)
- The default value will be `NewRelic-Logging-Delivery-Stream`
- `LoggingS3BackupBucketName`: S3 Bucket Destination for failed events (must be globally unique across all AWS accounts in all AWS Regions within a partition)
- The default value will be `firehose-logging-backup`
- `EnableCloudWatchLoggingForFirehose`: Can either be `true` or `false` to enable CloudWatch logging for the Amazon Data Firehose stream.
- `EnableCloudWatchLoggingForFirehose`: Can either be `true` or `false` to enable CloudWatch logging for the Amazon Data Firehose stream. Enabling logging can help in troubleshooting issues in pushing data through firehose stream. `false` by default
- `NewRelicAccountId` : The New Relic Account ID to which the logs will be pushed
- `CommonAttributes` : Common attributes to be added to all logs. This should be a JSON object.
- Example : ```[{"AttributeName": "name1", "AttributeValue": "value1"}, {"AttributeName": "name2", "AttributeValue": "value2}]```
- `StoreNRLicenseKeyInSecretManager` : Can either be `true` or `false` depending on which cloud formation stack decides whether to store your license key in the environment variables or to create a new secret in aws secrets manger.
- For this param `true` is default

## Building and packaging
To build and package, follow these steps:
Expand Down

0 comments on commit 9bf2300

Please sign in to comment.