From 9bf2300b1a2ca14cc283fcc622afd98cbc33c336 Mon Sep 17 00:00:00 2001 From: Himanshu Rai Date: Thu, 14 Nov 2024 15:39:07 +0530 Subject: [PATCH] added default and some descriptions --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fbf776b..4040d54 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ 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"}]``` @@ -28,11 +29,12 @@ To try this integration out you can use the `sam` cli to deploy the cloudformati - 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: