AWS CloudWatch Integration
What's New?
Now, you can integrate AWS CloudWatch with the SummitAI application. Using this integration, the Administrator can view the performance of services that are monitored in AWS CloudWatch on the SummitAI Application under the Reports page. Also, Incidents are logged in the SummitAI application for the configured Alarms on the AWS CloudWatch. For more information about AWS CloudWatch, see https://aws.amazon.com/cloudwatch/.
AWS CloudWatch Dashboard Integration
Now, you can integrate AWS CloudWatch Dashboard in the SummitAI application.
Prerequisites
Before integrating the SummitAI with AWS CloudWatch, review the following AWS considerations:
- Create an AWS account and an IAM administrator user
- Create an IAM user and get your AWS credentials
For more information on generating the Access Key and Secret Key, see AWS Prerequisite Document.
To integrate the AWS CloudWatch Dashboards, configure the AWS credentials on the MONITORING ACCOUNT page of the SummitAI application.
- Select Admin > Advanced > Discovery & Monitoring > Monitoring Account.
- On the MONITORING ACCOUNT page, click ADD NEW on the ACTIONS panel.
Select the Tenant, Used For as AWS, and specify all the required Monitoring Account details.
Field DescriptionField Description Used For
Select the filed value as AWS from the drop-down list. AWS Account Name Specify the unique account name for the AWS.
Access Key Specify the Access Key of the AWS account.
Secret Key Specify the Secret Key of the AWS account.
Re-enter Secret key Re-enter the specified Secret Key.
Description Specify the description for the monitoring account. Active Indicates the status set for the Monitoring Account.
- If selected, the Monitoring Account is enabled.
- If not selected, the Monitoring Account becomes inactive.
- Click SUBMIT.
- After the above configuration, based on the Role Template access, a new page, AWS CloudWatch Dashboard gets created with a tile AWS CloudWatch Dashboard under the Reports page.
Figure: AWS CloudWatch Dashboard - On the FILTERS pop-up page, select the configured AWS Account Name, and specify all the required details.
Figure: FILTERS pop-up page - Click SUBMIT. The AWS CLOUDWATCH DASHBOARD page is displayed. For more information, see AWS CLOUDWATCH DASHBOARD.
Figure: AWS CLOUDWATCH DASHBOARD
Logging Incidents Using AWS SNS
SummitAI logs Incidents for the configured Alarms that are received through the AWS SNS. Whenever an Alarm is created in the AWS, the SNS triggers an alarm and sends the Alarm to the SummitAI Application.
Process Flow for Logging Incidents:
- Create an SNS Topic and subscribe it using the Summit API.
Create an Alarm in CloudWatch and assign it to the above created SNS Topic.
Note:
For more information about creating of SNS Topic and assigning the configured Alarms, see prerequisites.
- CloudWatch forwards all the configured Alarms to the AWS SNS.
- Summit API receives a notification for each Alarm from AWS CloudWatch through AWS SNS.
SummitAI ITSM logs an Incident for each Alarm along with the Alarm details. You can configure the Incidents fields in the API's config file as follows:
<add key="API:URL" value="https://<<Customer_URL>>/REST/Summit_RESTWCF.svc/RESTService/Common WS_JsonObjCall>
<add key="API:UserName" value="john@xyz.com" />
<add key="API:Password" value="XXXXXXXXXXXXX" />
<add key="API:CallerEMailID" value="Peter@xyz.com" />
<add key="API:AssignedWorkGroup" value="IT Infrastructure" />
<add key="API:ApiKey" value="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" />
<add key="API:AuthType" value="APIKey" />
<add key="API:Tenant" value="Info" />
<add key="API:Impact" value="Medium" />
<add key="API:Priority" value="Priority 1" />
<add key="API:Urgency" value="Alarming" />
<add key="API:Category" value="Cross Instance" />
<add key="API:Classification" value="Network" />
Known Observations
The following known observations are found with the AWS CloudWatch Dashboards while filtering Dashboards:
- Metrix graph is displaying variation among the AWS CloudWatch Dashboard and the AWS CloudWatch Dashboard of the SummitAI application for the month filters.
- Even after you select and save the widget type as Number on the AWS CloudWatch Dashboard, a line graph is displaying on the AWS CloudWatch Dashboard of the SummitAI application.
Confluence Cloud Migration Alert: Please refer to known issues you may encounter in Confluence Cloud: https://eitdocs.atlassian.net/wiki/x/wDGwAQ