Skip to content

Commit

Permalink
Merge pull request #219 from NetApp/fix_cw_dashboard_readme
Browse files Browse the repository at this point in the history 
Fixed formatting issues.
  • Loading branch information
@kcantrel
kcantrel authored Feb 18, 2025
2 parents d33b29a + 19a2253 commit 7acacfb
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions Monitoring/CloudWatch-FSx/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,29 +109,29 @@ If not provided, some features may not operate correctly. This secret should con
## Alarms Configuration
The Lambda function is responsible for creating alarms based on the thresholds set via environment variables. These environment variables can be set from the AWS console, under the Configuration tab of the dashboard Lambda function. You can find the specific Lambda function by its name “FSxNDashboard-<CloudFormation-Stack-Name>.
The following environment variables are used:
1. CLIENT_THROUGHPUT_ALARM_THRESHOLD: This sets the threshold for the client throughput alarm. The default value is "90", but this can be customized as needed. When the client throughput exceeds this value (expressed as a percentage), an alarm will be triggered.
1. DISK_PERFORMANCE_ALARM_THRESHOLD: This sets the threshold for the disk performance alarm. The default value is "90", but this can be customized as needed. When the disk performance exceeds this value (expressed as a percentage), an alarm will be triggered.
1. DISK_THROUGHPUT_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the disk throughput utilization alarm. The default value is "90", but this can be customized as needed. When disk throughput utilization exceeds this value (expressed as a percentage), an alarm will be triggered.
1. SNAPMIRROR_UNHEALTHY_ALARM_THRESHOLD: This sets the threshold for the SnapMirror unhealthy alarm. The default value is "0", but this can be customized as needed. When the number of unhealthy SnapMirror relationships exceeds this value, an alarm will be triggered.
1. STORAGE_CAPACITY_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the storage capacity utilization alarm. The default value is "80", but this can be customized as needed. When storage capacity utilization exceeds this value (expressed as a percentage), an alarm will be triggered.
1. VOLUME_STORAGE_CAPACITY_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the volume storage capacity utilization alarm. The default value is "80", but this can be customized as needed. When volume storage capacity utilization exceeds this value (expressed as a percentage), an alarm will be triggered.
1. CLIENT_THROUGHPUT_ALARM_THRESHOLD: This sets the threshold for the client throughput alarm. The default value is "90", but this can be customized as needed. When the client throughput exceeds this value (expressed as a percentage), an alarm will be triggered.
1. DISK_PERFORMANCE_ALARM_THRESHOLD: This sets the threshold for the disk performance alarm. The default value is "90", but this can be customized as needed. When the disk performance exceeds this value (expressed as a percentage), an alarm will be triggered.
1. DISK_THROUGHPUT_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the disk throughput utilization alarm. The default value is "90", but this can be customized as needed. When disk throughput utilization exceeds this value (expressed as a percentage), an alarm will be triggered.
1. SNAPMIRROR_UNHEALTHY_ALARM_THRESHOLD: This sets the threshold for the SnapMirror unhealthy alarm. The default value is "0", but this can be customized as needed. When the number of unhealthy SnapMirror relationships exceeds this value, an alarm will be triggered.
1. STORAGE_CAPACITY_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the storage capacity utilization alarm. The default value is "80", but this can be customized as needed. When storage capacity utilization exceeds this value (expressed as a percentage), an alarm will be triggered.
1. VOLUME_STORAGE_CAPACITY_UTILIZATION_ALARM_THRESHOLD: This sets the threshold for the volume storage capacity utilization alarm. The default value is "80", but this can be customized as needed. When volume storage capacity utilization exceeds this value (expressed as a percentage), an alarm will be triggered.

In addition to the environment variables, you can use tags on the FSx and volume resources to override default thresholds or skip alarm management for specific resources. If a threshold is set to 100, the alarm will not be created. Similarly, skip tag is set to true, the alarm will be skipped.

The tag keys used for this purpose are:

1. client-throughput-alarm-threshold
1. skip-client-throughput-alarm
1. disk-performance-alarm-threshold
1. skip-disk-performance-alarm
1. disk-throughput-utilization-threshold
1. skip-disk-throughput-utilization-alarm
1. storage-capacity-utilization-alarm-threshold
1. skip-storage-capacity-utilization-alarm
1. volume-storage-capacity-utilization-alarm-threshold
1. skip-volume-storage-capacity-utilization-alarm
1. snapMirror-unhealthy-relations-alarm-threshold
1. skip-snapmirror-unhealthy-relations-alarm
1. client-throughput-alarm-threshold
1. skip-client-throughput-alarm
1. disk-performance-alarm-threshold
1. skip-disk-performance-alarm
1. disk-throughput-utilization-threshold
1. skip-disk-throughput-utilization-alarm
1. storage-capacity-utilization-alarm-threshold
1. skip-storage-capacity-utilization-alarm
1. volume-storage-capacity-utilization-alarm-threshold
1. skip-volume-storage-capacity-utilization-alarm
1. snapMirror-unhealthy-relations-alarm-threshold
1. skip-snapmirror-unhealthy-relations-alarm

## Important Disclaimer: CloudWatch Alarms Deletion
Please note that when you delete the CloudFormation stack associated with this project, the CloudWatch Alarms created by the stack will not be automatically deleted.
Expand Down

0 comments on commit 7acacfb

Please sign in to comment.