Made minor documentation changes.

Author: kcantrel

Monitoring/auto-add-cw-alarms/README.md

@@ -4,27 +4,27 @@
 There are times when you want to be notified when a FSx for ONTAP file system, or one of its volumes, is reaching
 its capacity. AWS CloudWatch has metrics that can give you this information. The only problem is that they are
 on a per instance basis. This means as you add and delete file systems and/or volumes, you have to add and
-delete alarms. This can be tedious, and error prone. This script will automates the creation of
+delete alarms. This can be tedious, and error prone. This script will automate the creation of
 AWS CloudWatch alarms that monitor the utilization of the file system and its volumes. It will also create alarms
 to monitor the CPU utilization of the file system. And if a volume or file system is removed, it will remove the associated alarms.
 
-To implement this, you might think to just create EventTail filters to tigger on FSx Volume Create and Volume Delete
-events. This would kind of work, but since you have command line access to the FSx for ONTAP file system, you can create
-and delete volumes without creating CloudTrail events. So, instead of relying on those events, this script will
-scan all the file systems and volumes in all the regions then create and delete alarms as needed.
+To implement this, you might think to just create EventTail filters to trigger on the creation or deletion of an FSx Volume.
+This would kind of work, but since you have command line access to the FSx for ONTAP file system, you can create
+and delete volumes without creating CloudTrail events. So, this method would not be reliable. Therefore, instead
+of relying on those events, this script will scan all the file systems and volumes in all the regions then create and delete alarms as needed.
 
 ## Invocation
-There are two way you can invoke this script (Python program). Either from a computer that has Python installed, or you could upload it
+There are two ways you can invoke this script (Python program). Either from a computer that has Python installed, or you could upload it
 as a Lambda function.
 
 ### Configuring the program
 Before you can run the program you will need to configure it. You can configure it two ways. Either by editing the top part of the program itself,
-where there are the following variable defitions, or if you are running it as a standalong program, via some command line options.
+where there are the following variable definitions, or if you are running it as a standalone program, via some command line options.
 Here is the list of variables, and what they define:
 
 | Variable | Description |Command Line Option|
 |:---------|:------------|:--------------------------------|
-|SNStopic  | The SNS Topic name where CloudWatch will send alerts to. Note that it is assumed that the SNS topic, with the same name, will exist in all the regions where where alarms are to be created.|-s SNS_Topic_Name|
+|SNStopic  | The SNS Topic name where CloudWatch will send alerts to. Note that it is assumed that the SNS topic, with the same name, will exist in all the regions where alarms are to be created.|-s SNS_Topic_Name|
 |accountId | The AWS account ID associated with the SNStopic. This is only used to compute the ARN to the SNS Topic.|-a Account_number|
 |customerId| This is really just a comment that will be added to the alarm description.|-c Customer_String|
 |defaultCPUThreshold | This will define the default CPU utilization threshold. You can override the default by having a specific tag associated with the file system. See below for more information.|-C number|
@@ -37,7 +37,7 @@ Here is the list of variables, and what they define:
 As mentioned with the threshold variables, you can create a tag on the specific resource to override the default value set by the associated threshold
 variable. Here is the list of tags and where they should be located:
 
-|Tag|Descrption|location|
+|Tag|Description|Location|
 |:---|:------|:---|
 |alarm_threshold | Sets the volume utilization threshold. | Volume |
 |cpu_alarm_threshold| Sets the CPU utilization threshold. | File System |
@@ -46,7 +46,7 @@ variable. Here is the list of tags and where they should be located:
 :bulb: **NOTE:** When the alarm threshold is set to 100, the alarm will not be created. So, if you set the default to 100, then you can selectively add alarms by setting the appropriate tag.
 
 ### Running on a computer
-To run the program on a computer, you will must have Python installed. You will also need to install the boto3 library.
+To run the program on a computer, you must have Python installed. You will also need to install the boto3 library.
 You can do that by running the following command:
 
 ```bash
@@ -62,22 +62,22 @@ having to edit the program, you can use the Command Line Option specified in the
 option and the program will display a list of all the available options.
 
 You can limit the regions that the program will act on by using the `-r region` option. You can specify that option
-mulitple times to act on multiple regions.
+multiple times to act on multiple regions.
 
-You can run the program in "Dry Run" mode by speficying the `-d` (or `--dryRun`) option. This will cause the program to only display
+You can run the program in "Dry Run" mode by specifying the `-d` (or `--dryRun`) option. This will cause the program to only display
 messages showing what it would have done, and not really create or delete any CloudWatch alarms.
 
 ### Running as a Lambda function
 If you run the program as a Lambda function, you will want to set the timeout to at least two minutes since some of the API calls
-can take a sigificant amount of "clock time" to run, especially in distant regions.
+can take a significant amount of "clock time" to run, especially in distant regions.
 
 Once you have installed the Lambda function it is recommended to set up a scheduled type EventBridge rule so the function will run on a regular basis.
 
 The appropriate permissions will need to be assigned to the Lambda function in order for it to run correctly.
 It doesn't need many permissions. It just needs to be able to:
 * List the FSx for ONTAP file systems
 * List the FSx volume names
-* List the CloudWatch Alarms
+* List the CloudWatch alarms
 * Create CloudWatch alarms
 * Delete CloudWatch alarms
 * Create CloudWatch Log Groups and Log Streams in case you need to diagnose an issue
@@ -125,10 +125,10 @@ The following permissions are required to run the script (although you could nar
 Once the script has been configured and invoked, it will:
 * Scan for every FSx for ONTAP file systems in every region. For every file system it finds it will:
     * Create a CPU utilization CloudWatch alarm, unless the threshold value is set to 100 for the specific alarm.
-	* Create a SSD utilization CloudWatch alarm, unless the threshold value is set to 100 for the specific alarm.
+    * Create a SSD utilization CloudWatch alarm, unless the threshold value is set to 100 for the specific alarm.
 * Scan for every FSx for ONTAP volume in every region. For every volume it finds it will:
-    * Create a Volume Utilization CloudWatch alarms, unless the threshold value is set to 100 for the specific alarm.
-* Scan for the CloudWatch alarms, and remove any alarms that the associated resource doens't exist anymore.
+    * Create a Volume Utilization CloudWatch alarm, unless the threshold value is set to 100 for the specific alarm.
+* Scan for the CloudWatch alarms and remove any alarms that the associated resource doesn't exist anymore.
 
 
 ## Author Information

Monitoring/auto-add-cw-alarms/auto_add_cw_alarms.py

@@ -327,7 +327,7 @@ def lambda_handler(event, context):
                         fsName = fsId.replace('fs-', 'FsxId')
                         alarmDescription = f"Volume utilization alarm for volumeId {volumeId}{customerId}, File System Name: {fsName}, Volume Name: {volumeName} in region {region}."
                         if(not contains_alarm(alarmName, alarms)):
-                            print(f'Adding volume utilization alarm for {volume["Name"]} in region {region}.')
+                            print(f'Adding volume utilization alarm for {volumeName} in region {region}.')
                             add_volume_alarm(cw, volumeId, alarmName, alarmDescription, fsId, threshold, region)
             #
             # Scan for volume alarms without volumes.