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 3 Next »

What does the integration offer?

BMC TrueSight Pulse sends notifications for alarms. With BMC TrueSight Pulse Integration, Compass acts as a dispatcher for these alarms, determines the right people to notify based on on-call schedules notifies via email, text messages (SMS), phone calls and iPhone and Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

When an alert is created in BMC TrueSight Pulse, an alert is created in Compass automatically through the integration.

Set up the integration

BMC TrueSight Pulse is an API integration. Setting it up involves the following steps:

  • Add a BMC TrueSight Pulse integration in Compass

  • Configure the integration in BMC TrueSight Pulse

Add a BMC TrueSight Pulse integration

Bidirectional integrations aren’t supported in the Standard plan. All the other integrations are supported at a team level in Standard.

If you're using the Standard plan in Compass, you can add this integration only from your team’s operations page. 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 a BMC TrueSight Pulse 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 “BMC TrueSight Pulse”.

  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 API key.
    You will use this key while configuring the integration in BMC TrueSight Pulse later.

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

Configure the integration in BMC TrueSight Pulse

To configure the integration of BMC TrueSight Pulse with Compass, complete the following steps:

  1. Go to Settings > Actions.

  2. Select Add Action and then Compass.

  3. Enter “Opsgenie” for Name.

  4. Paste the API key you copied earlier into API Key.

  5. Select Save.

  6. Go to Settings > Alarms.

  7. Add a new alarm or edit an existing one.

  8. Under Actions, add an Opsgenie action.

  9. Select Notify for every change to receive notifications for each server in the group monitored by the alarm.

Sample payload sent from BMC TrueSight Pulse

Create Alert payload (in JSON format)

{
  "alarmName": "CPU usage is high",
  "status": "TRIGGERED",
  "metric": {
    "id": "cpu",
    "name": "CPU utilization",
    "type": "percent"
  },
  "affectedServers": {
    "boundary": {
      "isSet": true,
      "hostname": "boundary",
      "aggregate": "avg",
      "metric": "CPU utilization",
      "value": 0.027916727272727274,
      "threshold": 0.02,
      "time": 1421887800000,
      "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
      "text": {
        "isSet": true,
        "serverName": "boundary",
        "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
        "labelHTML": "Server boundary's avg CPU utilization is 2.8% which is greater than the threshold of 2.0%",
        "labelText": "Server boundary's avg CPU utilization is 2.8% which is greater than the threshold of 2.0%"
      }
    }
  },
  "boundary2": {
    "isSet": true,
    "hostname": "boundary2",
    "aggregate": "avg",
    "metric": "CPU utilization",
    "value": 0.027916727272727274,
    "threshold": 0.02,
    "time": 1421887800000,
    "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
    "text": {
      "isSet": true,
      "serverName": "boundary2",
      "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
      "labelHTML": "Server boundary's label",
      "labelText": "Server boundary's avg CPU utilization is 2.8% which is greater than the threshold of 2.0%"
    }
  },
  "resolvedServers": {
    "boundary": {
      "isSet": false,
      "hostname": "boundary",
      "aggregate": "avg",
      "metric": "CPU utilization",
      "value": 0.004986516666666667,
      "threshold": 0.02,
      "time": 1421887380000,
      "text": {
        "isSet": false,
        "serverName": "boundary",
        "labelHTML": "Server boundary's avg CPU utilization has returned to the acceptable 0.5%",
        "labelText": "Server boundary's avg CPU utilization has returned to the acceptable 0.5%",
        "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887380000!cpu"
      }
    }
  }
}

This payload is parsed by Compass as follows:

(in JSON format)

{
  "alarmName": "CPU usage is high",
  "status": "TRIGGERED",
  "metricId": "cpu",
  "metricName": "CPU utilization",
  "type": "percent",
  "affectedServers": {
    "boundary": {
      "isSet": true,
      "hostname": "boundary",
      "aggregate": "avg",
      "metric": "CPU utilization",
      "value": 0.027916727272727274,
      "threshold": 0.02,
      "time": 1421887800000,
      "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
      "text": {
        "isSet": true,
        "serverName": "boundary",
        "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887800000!cpu",
        "labelHTML": "Server boundary's avg CPU utilization is 2.8% which is greater than the threshold of 2.0%",
        "labelText": "Server boundary's avg CPU utilization is 2.8% which is greater than the threshold of 2.0%"
      }
    }
  },
  "resolvedServers": {
    "boundary": {
      "isSet": false,
      "hostname": "boundary",
      "aggregate": "avg",
      "metric": "CPU utilization",
      "value": 0.004986516666666667,
      "threshold": 0.02,
      "time": 1421887380000,
      "text": {
        "isSet": false,
        "serverName": "boundary",
        "labelHTML": "Server boundary's avg CPU utilization has returned to the acceptable 0.5%",
        "labelText": "Server boundary's avg CPU utilization has returned to the acceptable 0.5%",
        "link": "https://premium.boundary.com/home/1829/standard?ival=60&marker=1421887380000!cpu"
      }
    }
  }
}
  • No labels