About Data Gateway monitoring through CloudWatch alarms
Performance of the Data Gateway components is monitored through CloudWatch alarms. Various metrics related to the different services can be used to notify you about the changes, errors, and costs related to the Veritas Data Gateway.
In order to send notifications whenever alarms are triggered, an SNS topic is created by the Data Gateway. A topic is a communication channel to send messages and subscribe to the notifications. Once a topic gets created, you can subscribe an endpoint to receive the messages published to the topic. While deploying the Data Gateway, you need to select a value for for receiving the notifications, and you need to enter the value for accordingly.
Refer to the AWS documentation for information on SNS topic protocol and corresponding SNS topic endpoint.
When a topic is created, a few alarms get created by default with the default threshold values, which may or may not be suitable for your environment. You need to review these alarms and modify those parameters or threshold values, if required. To review these alarms, go to the CloudWatch service in the AWS console, click on Alarms. Check all the alarms that have the Data Gateway stack name as a prefix.
The Data gateway components log their actions in the CloudWatch service. Each component creates a CloudWatch log group which is named after itself. Within this log group, log streams are created and receive logs for a certain amount of time. To collect logs for debugging you can follow one of the following steps:
You need to login to AWS Step functions console. You can find data gateway Loggather state machines on which log gather script can be executed. Start execution on this machine using execution button on the page. Enter the date from which logs are to be collected. If no date is provided, it exports all the logs in the data gateway bucket.
You can also use AWS API Gateway Console to invoke Veritas Data Gateway APIs. Follow AWS documentation for the steps to invoke an API. Pass the date as an argument in the request from which logs are to be collected. If no date is provided, it exports all the logs in the data gateway bucket.
You must not delete any alarms that has been created by default. You can create additional alarms to monitor the various components of the Data Gateway. Note that any alarm that you create additionally does not automatically get deleted when you delete the Data Gateway. You need to manually delete these alarms when you delete the Data Gateway.