ThousandEyes

Describes how to set up an integration to ingest ThousandEyes alerts in OpsRamp.

Leave Feedback

Introduction

ThousandEyes is a network infrastructure monitoring provider. ThousandEyes provides effective troubleshooting of application delivery and maps Internet performance from a SaaS-based platform.

OpsRamp integration supports Webhooks to manage alerts from ThousandEyes monitoring events.

The current ThousandEyes version supported for integration is the March 23, 2020 release.

OpsRamp configuration

Configuration involves:

  1. Installing the integration
  2. Configuring the integration

Step 1: Install the integration

To install ThousandEyes into the system:

  1. Go to Setup > Integrations > Integrations.
  2. From Available Integrations, select Monitoring > ThousandEyes.
  3. Click Install.

After the installation, an API panel appears.

Step 2: Configure the integration

Inbound configurations capture all the required details to call OpsRamp APIs in Site24x7.

Authentication

  1. Configure the Authentication type to call OpsRamp APIs.
  2. Select Webhooks as the authentication mechanism to generate the Token and WebHook URL. Both are required to define alert endpoints.

Configuring the map attributes

To configure the map attributes:

  1. From the options in the OpsRamp Entity menu, click Alert.
  2. From the OpsRamp Property menu, click Status.
  3. Click + to define the mappings. Create Alert Mappings on Status is displayed.

The following table describes mapping attributes.

Property Mappings
Third-Party EntityOpsRamp EntityThird-Party PropertyOpsRamp Property (non-editable)
ProblemAlerteventType
Third-Party Property ValueOpsRamp Property Value
ALERT_NOTIFICATION_CLEARCritical
ALERT_NOTIFICATION_TRIGGERCritical
WEBHOOK_TESTOk
alert.currentState
ProblemAlertalert.typealert.serviceName
ProblemAlertalert.testName
ruleName : $alert.ruleName
violationCount : $alert.violationCount
permalink : $alert.permalink
testId : $alert.testId
ruleId : $alert.ruleId
alert.description
ProblemAlertalert.testNamealert.deviceName
ProblemAlertalert.ruleNamealert.subject

ThousandEyes configuration

Configuring ThousandEyes involves:

  • Creating a test.
  • Creating an alert rule.

Step 1: Create test

To configure alerts:

  1. Log into ThousandEyes Admin UI.
  2. From the left pane, navigate to Cloud and Enterprise Agents > Test Settings and click Add New Test. A new test dialog is displayed.
  3. Perform the following steps for the new test block:
    1. Select Layer.
      For example: Web
    2. Select a Test Type.
      For example: HTTP Server
    3. Enter a unique Test Name. The Basic Configuration displays fields according to the selections of the layer and test type.
    4. Enter the basic configuration details. For example, if the layer is Web, then the URL field is displayed. The fields, such as, Interval, Agents, and Alerts are common. Select the values accordingly from the drop-down menu and make sure that the Alerts checkbox is selected.
    5. Without modifying advanced settings, click Create New Test.

The new test is added.

Step 2: Create alert rule

To create an alert rule for the added new test:

  1. From the ThousandEyes panel, go to Alerts > Alert Rules and click Add New Alert Rule. The Add New Alert Rule dialog box is displayed. Alert Type displays the Layer (Web) and Test Type (HTTP Server) that was selected in step 1.
  2. Enter a unique Rule Name.
  3. For Settings, perform the following steps:
    1. From the Tests drop-down, select the name of the new added test.
    2. Select the Agents for the new rule.
      For example, leave the default selection of None for Auth Type.
    3. In Alert Conditions, specify the conditions (if any) that the alert must meet in the drop-down. To add (or remove) an alert condition, click the + (or -) button.
  4. Perform the following steps on the Notifications tab to configure Webhook URL and add:
    1. For Webhooks, perform the following steps to Edit webhooks for send notifications:
      1. Enter a unique name.
      2. Enter the Webhook URL copied during OpsRamp.
        For example,  [https://example.opsramp.com/integrations/alertsWebhook/{tenant Id}/alerts?vtoken=Vdslfndnx93Y2cK7FsxG8qp2StKb](https://{yourdomain}:/integrations/alertsWebhook/client_1/alerts?vtoken={token}).
      3. Click Test to verify the Webhook URL.
      4. Click Add New Webhook.
    2. Select the Webhook URL created from the drop-down menu.
  5. Click Save Changes.

The new alert rule is created.

Sample payload

{
  "eventType": "ALERT_NOTIFICATION_TRIGGER",
  "eventId": "105777903-38417150",
  "alert": {
    "agents": [
      {
        "active": 1,
        "metricsAtStart": "Error: "404 Not Found"",
        "metricsAtEnd": "",
        "agentId": 48608,
        "agentName": "Atlanta, GA (Trial) - IPv6",
        "dateStart": "2020-04-03 06:18:03",
        "permalink": "https://app.thousandeyes.com/alerts/list/?__a=180546&alertId=38417150&agentId=48608"
      },
      {
        "active": 1,
        "metricsAtStart": "Error: "404 Not Found"",
        "metricsAtEnd": "",
        "agentId": 4512,
        "agentName": "Atlanta, GA (Trial)",
        "dateStart": "2020-04-03 06:18:03",
        "permalink": "https://app.thousandeyes.com/alerts/list/?__a=180546&alertId=38417150&agentId=4512"
      },
      {
        "active": 1,
        "metricsAtStart": "Error: "404 Not Found"",
        "metricsAtEnd": "",
        "agentId": 4516,
        "agentName": "New York, NY (Trial)",
        "dateStart": "2020-04-03 06:18:03",
        "permalink": "https://app.thousandeyes.com/alerts/list/?__a=180546&alertId=38417150&agentId=4516"
      }
    ],
    "alertId": 38417150,
    "dateStart": "2020-04-03 06:18:03",
    "apiLinks": [
      {
        "rel": "related",
        "href": "https://api.thousandeyes.com/v4/tests/1294019"
      },
      {
        "rel": "data",
        "href": "https://api.thousandeyes.com/v4/web/http-server/1294019"
      }
    ],
    "permalink": "https://app.thousandeyes.com/alerts/list/?__a=180546&alertId=38417150",
    "ruleExpression": "Error is present",
    "ruleId": 1140394,
    "ruleName": "Test_Integration",
    "testId": 1294019,
    "testName": "New_Test",
    "violationCount": 3,
    "type": "HTTP Server"
  }
}

Viewing alerts

To view the alerts:

  1. Select the Workspace drop-down option and go to Alerts.
  2. Search for ThousandEyes as the source name to view alerts.
  3. Click an alert ID.
Viewing Alerts

Viewing Alerts