SolarWinds

SolarWinds provides monitoring tools for systems and network management. Install this integration to correlate Orion alerts from any module into high-level incidents in BigPanda so that you can understand and respond faster to critical issues.

Instructions in BigPanda Console

Please note that the instructions on this page are current, the instructions in the BigPanda console are in the process of being updated.

Supported Versions:
Orion Server, Versions 2015.1+; Network Performance Monitor (NPM) 10.4+

Type:
Webhook

Key Features

  • Uses native SolarWinds Actions to forward alerts to BigPanda
  • Extensible alert template allows you to customize the alerts to your needs
  • Alerts configured with the provided reset action will automatically resolve in BigPanda when reset
  • Uses new BigPanda integration installer which
    • Supports remote installation (must be able to communicate with the SolarWinds server)
    • Provides descriptive feedback in the event of an issue

How It Works

The integration works by subscribing BigPanda to all SolarWinds alert notification. This is accomplished by creating both a trigger and reset action within SolarWinds and attaching these actions to all alerts. When a subscribed alert is triggered a notification is sent to the BigPanda API endpoint. BigPanda then processes and correlates the alert data from SolarWinds to create and maintain up-to-date incidents in BigPanda.

SolarWinds Data Model

BigPanda normalizes alert data from SolarWinds into tags. You can use tag values to filter the incident feed and to define filter conditions for Environments. The primary and secondary properties are also used during the correlation process.

Standard Tags

Tag
Description
Attributes

alert

Alert name in SolarWinds.

host

Hostname of the node the alert is related to.

object

Name of the object the alert is related to.

object_type

Type of the object the alert is related to (for example, Node).

solarwinds_url

Link to the alert in SolarWinds

status

Severity of the alert from SolarWinds

acknowledged

Flag indicating if the alert was acknowledged.

acknowledged_by

Name of the person who acknowledged the alert.

Managing the Integration

Installer Downloads

Prerequisites

  • Download the BigPanda SolarWinds Installer utility for your operating system
  • Obtain network access to the SolarWinds controller and credentials for a user account which has, at minimum, permission to manage alerts

Installing The Integration

To install the integration use the BigPanda SolarWinds Installer utility to automatically configure SolarWinds to send alerts to BigPanda

The BigPanda SolarWinds installer tool

The BigPanda SolarWinds installer tool

  1. Run the BigPanda SolarWinds installer tool
    • This must be run on either the SolarWinds server or another machine which has network access to the SolarWinds server
  2. Fill in the details for your SolarWinds server and account
    • Make sure that SolarWinds Server REST API URL contains the port for your SolarWinds server's REST API. If you're not sure what it is you can try the default port, 17778
  3. Fill in the BigPanda app key for your integration and authentication token
  4. Click Install and wait for the installation to complete
    • Depending on the amount of alerts you have this could take a couple minutes to configure
    • In the event of an issue you'll be provided a descriptive message to help troubleshoot

Validating Install

  1. Navigate to Settings > All Settings
  2. Under Alerts & Reports select Manage Alerts
  3. Open the Action Manager tab
  4. Search for BigPanda and ensure that both the reset and trigger actions show up
    • Send to BigPanda - Trigger
    • Send to BigPanda - Reset
  5. Ensure that both actions are assigned to all of your alerts

Keeping SolarWinds Updated

To ensure all your alert information is available in BigPanda it's important to assign the BigPanda integration actions whenever you create a new alert.

When creating a new Alert:

  1. On the Trigger Actions step click Assign Action(s)
  2. Select Send to BigPanda - Trigger
  3. On the Reset Actions step click Assign Action(s)
  4. Select Send to BigPanda - Reset
  5. On the Summary step ensure both BigPanda actions are assigned.
  6. Click Submit

Uninstalling SolarWinds

To uninstall the integration use the BigPanda SolarWinds Installer utility to automatically remove the BigPanda configuration from SolarWinds.

  1. Run the BigPanda SolarWinds installer tool
    • This must be run on either the SolarWinds server or another machine which has network access to the SolarWinds server
  2. Fill in the details for your SolarWinds server and account
  3. Click Uninstall and wait for the uninstallation to complete
    • In the event of an issue you'll be provided a descriptive message to help troubleshoot
  4. Manually resolve any open incidents related to the integration to remove them from your incident feed. Optionally, remove any additional data in BigPanda. For example, modify or remove any Environments or AutoShare rules that reference the integration
  5. Delete the Integration in BigPanda to remove the SolarWinds integration from your UI.

Troubleshooting

I can't connect to the SolarWinds server

Ensure the following:

  1. Your REST API URL is using https, not http
  2. Your REST API URL has the correct port for the SolarWinds REST API (usually 17778)
  3. You have the correct username & password with admin access

Help! I can't get the installer to work!

If for some reason the installer simply won't work you can configure the SolarWinds server by hand in just a few minutes.

Manually configuring the SolarWinds server

  1. Create new actions in SolarWinds

    1. Navigate to Alerts > Manage Alerts
    2. Select any alert and click Edit Alert (you cannot directly create a new action)
    3. Click the Trigger Actions step and then click Add Action
    4. Select Send a GET or POST Request to a Web Server
    5. Click Configure Action
    6. Fill in the Action Pane with the following details
      • Name of Action: Send to BigPanda - Trigger
      • URL: https://inbound.bigpanda.io/solarwinds/alerts?access_token=ORG_TOKEN (replace with actual token)
      • Select: Use HTTP/S POST
      • Body to Post: Fill in from Alert Template -- Trigger Action below, replacing app_key with the appropriate BigPand app key
      • Time of Day: No additional schedule for this action needed
      • Executon Settings: Leave as Is
    7. Click Add Action
    8. Click the Reset Actions step and then repeat steps 4 - 7, using the Reset Action template instead of the Trigger Action template
    9. Click Next
    10. Click Submit on the Summary page
  2. Assign actions to all desired alerts

    1. From the Alert Manager view select all the alerts you wish to send to BigPanda (or click select all if everything) and then click Assign Action > Assign Trigger Action
    2. Select the Send to BigPanda - Trigger action and click Assign
    3. Repeat for Assign Action > Assign Reset Action using the Send to BigPanda - Reset action

Alert Template - Trigger Action

{
"app_key": "APP_KEY",
"primary_property": "host",
"secondary_property": "object",
"status": "${N=Alerting;M=Severity}",
"alert": "${N=Alerting;M=AlertMessage}",
"host": "${N=SWQL;M=SELECT TOP 1 RelatedNodeCaption FROM Orion.AlertObjects WHERE AlertObjectID = ${N=Alerting;M=AlertObjectID} }",
"object": "${N=SWQL;M=SELECT TOP 1 EntityCaption FROM Orion.AlertObjects WHERE AlertObjectID = ${N=Alerting;M=AlertObjectID} }",
"object_type": "${N=Alerting;M=ObjectType}",
"description": "${N=Alerting;M=AlertDescription}",
"solarwinds_url": "${N=Alerting;M=AlertDetailsUrl}",
"acknowledged": "${N=Alerting;M=Acknowledged}",
"acknowledged_by": "${N=Alerting;M=AcknowledgedBy}",
"timestamp": "${N=SWQL;M=SELECT GETUTCDATE() as a1 FROM Orion.Engines}",
"incident_identifier": "${N=Alerting;M=AlertObjectID}"
}

Alert Template - Reset Action

{
"app_key": "APP_KEY",
"primary_property": "host",
"secondary_property": "object",
"status": "${N=Alerting;M=Severity}",
"alert": "${N=Alerting;M=AlertMessage}",
"host": "${N=SWQL;M=SELECT TOP 1 RelatedNodeCaption FROM Orion.AlertObjects WHERE AlertObjectID = ${N=Alerting;M=AlertObjectID} }",
"object": "${N=SWQL;M=SELECT TOP 1 EntityCaption FROM Orion.AlertObjects WHERE AlertObjectID = ${N=Alerting;M=AlertObjectID} }",
"object_type": "${N=Alerting;M=ObjectType}",
"description": "${N=Alerting;M=AlertDescription}",
"solarwinds_url": "${N=Alerting;M=AlertDetailsUrl}",
"acknowledged": "${N=Alerting;M=Acknowledged}",
"acknowledged_by": "${N=Alerting;M=AcknowledgedBy}",
"timestamp": "${N=SWQL;M=SELECT GETUTCDATE() as a1 FROM Orion.Engines}",
"incident_identifier": "${N=Alerting;M=AlertObjectID}",
"reset": true
}

SolarWinds


SolarWinds provides monitoring tools for systems and network management. Install this integration to correlate Orion alerts from any module into high-level incidents in BigPanda so that you can understand and respond faster to critical issues.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.