Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

What does the integration offer?

Amazon RDS (Relational Database Service) provides cost-efficient, resizeable capacity for an industry-standard relational database and manages everyday database administration tasks.

Amazon RDS sends notifications of database events through SNS. Compass acts as a dispatcher for these notifications, determines the right people to notify based on on-call schedules – notifies them using email, text messages (SMS), phone calls, and iPhone & Android push notifications, and escalates alerts until they are acknowledged or closed. Amazon RDS sends DB notifications like shutdown or backup, and Compass ensures the right people are notified.

How does the integration work?

When an alert is created in Amazon RDS, an alert is created in Compass automatically through the integration.

Set up the integration

Amazon RDS is an API-based integration. Setting it up involves the following steps:

  • Add an Amazon RDS integration in Compass

  • Set up a subscription in Amazon RDS

Add an Amazon RDS integration

Bidirectional integrations aren’t supported in Free and Standard plans. All the other integrations are supported at a team level in Free and Standard; however, for their outgoing part to work, you need to upgrade to a higher plan. To add any integration at a site level through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be either on Premium or Enterprise.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add an Amazon RDS integration in Compass, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Amazon RDS”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Expand the Steps to configure the integration section and copy the integration URL, which includes Compass endpoint and the API key.
    You will use this URL while configuring the integration in Amazon RDS later.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

Set up a subscription in Amazon RDS

To configure the integration in Amazon RDS, complete the following steps:

  1. Create an SNS topic. Find out how to get started with Amazon SNS.

  2. Add an HTTPS subscription to your topic with the integration URL (copied while adding the integration in Compass) as the endpoint. Find out how to add an HTTPS subscription. If the configuration is successful, a confirmation alert is created in Compass.

  3. Create an event subscription from the RDS Dashboard that sends notifications to the SNS topic you created earlier. Read more about working with Amazon RDS event notification.

Sample payload sent from Amazon RDS

Create alert payload (in JSON format)

{
  "Type":"Notification",
  "MessageId":"1cf7a0eb-4179-4181-b15b-ea22c5axxx",
  "TopicArn":"arn:aws:sns:us-east-1:08931xxxxxx:CloudWatchHTTPAlarms",
  "Subject":"ALARM: \"cpuUtilTest\" in US - N. Virginia",
  "Message":"{\"Event Source\":\"db-instance\",\"Event Time\":\"2014-10-28 08:13:15.339\",\"Identifier Link\":\"https://console.aws.amazon.com/rds/home?region=us-east-1#\\nSourceId: aydentifayir \",\"Event ID\":\"http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/USER_Events.html#RDS-EVENT-0019\",\"Event Message\":\"Restored from DB instance mydbinstins to 2014-10-28 08:00:00.0\"}",
  "Timestamp":"2012-08-05T22:31:30.673Z",
  "SignatureVersion":"1",
  "Signature":"XrsO2wtE0b+xxxxxxxxxlimTUg+rV4U9RmNSSBEdlmyWvtGgpjebsmNv1wkjUsBQOJZjZnpZp5FBn6quAn3twNdRMmMLf15lv6ESbxxxxxxxxxxxx/ZLwiH9Pr/cxVYOR0aPQBPDwTYn8w6g=",
  "SigningCertURL":"https://sns.us-east-1.amazonaws.com/SimpleNotificationService-f3ecfb7224c7233fexxxxxxf.pem",
  "UnsubscribeURL":"https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:08931xxxxxxx:CloudWatchHTTPAlarms:1841c5ca-ddda-xxxxxxbfb-bf0cf15813db"
}

 

{
  "TopicArn": "arn:aws:sns:us-east-1:089xxxxxxxxx:CloudWatchHTTPAlarms",
  "Subject": "ALARM: \"cpuUtilTest\" in US - N. Virginia",
  "Event Source": "db-instance",
  "Event ID": "http://docs.amazonwebservices.com/AmazonRDS/latest/UserGuide/USER_Events.html#RDS-EVENT-0019",
  "Event Message": "Restored from DB instance mydbinstins to 2014-10-28 08:00:00.0",
  "Identifier Link": "https://console.aws.amazon.com/rds/home?region=us-east-1#",
  "SourceId": "sourceID"
}
  • No labels