SolarWinds
Send monitoring events from Solarwinds to BigPanda.
Supported Versions | Type | Authentication Type |
---|---|---|
Orion Server/Network Performance Monitor, Versions <= 2022.4 | Webhook | Org Bearer Token |
The integration works by subscribing BigPanda to all SolarWinds alert notifications. 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.
The Open Integration Manager is available for use with SolarWinds. For more information, see the Open Integration Manager documentation.
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 the 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.
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. | Primary Property. |
object | Name of the object the alert is related to. | Secondary Property. |
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. |
Manage the Integration
Installer Downloads
Before You Start
- 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.
Install The Integration
Administrators can install the integration by following the on-screen instructions in BigPanda.
Keep 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:
- On the Trigger Actions step click Assign Action(s).
- Select Send to BigPanda - Trigger.
- On the Reset Actions step click Assign Action(s).
- Select Send to BigPanda - Reset.
- On the Summary step ensure both BigPanda actions are assigned.
- Click Submit.
Upgrade the Integration
If you are using the old version of the BigPanda SolarWinds integration you may want to consider upgrading to the latest version.
Features and Improvements
- No reliance on mapping enrichment, hostname is added to alert payload automatically.
- No reliance on "external" scripts or database access / modification.
- Send customizable and extensible payloads to BigPanda.
- Easily install and manage the integration with the installer tool and SolarWinds console.
- Uses SolarWinds supported method for sending alerts to BigPanda for long-term stability and reliability.
Upgrade Process
- Remove the old SolarWinds integration:
- Download the old integration's config tool from the old SolarWinds integration instructions page in BigPanda.
- Run the
./bigpanda-solarwinds-config list
command to find your existing subscriptions. - Run the
./bigpanda-solarwinds-config uninstall
command to remove each subscription. - Delete the old SolarWinds integration in BigPanda.
- In BigPanda create a new SolarWinds integration. Do not reuse the old integration.
- Follow the steps in Installing the Integration.
Troubleshooting
I can't connect to the SolarWinds server
Ensure the following:
- Your REST API URL is using
https
, nothttp
. - Your REST API URL has the correct port for the SolarWinds REST API (usually
17778
). - You have the correct username and 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
-
Create new actions in SolarWinds:
- Navigate to Alerts > Manage Alerts.
- Select any alert and click Edit Alert (you cannot directly create a new action).
- Click the Trigger Actions step and then click Add Action.
- Select Send a GET or POST Request to a Web Server.
- Click Configure Action.
- Fill in the Action Pane with the following details:
- Name of Action: Send to BigPanda - Trigger
- URL:
https://integrations.bigpanda.io/oim/solarwinds/alerts?access_token=ORG_TOKEN
(replace ORG_TOKEN with actual bearer token) - Select: Use HTTP/S POST
- Body to Post: Fill in from Alert Template -- Trigger Action below, replacing [INSERT_APP_KEY] with the appropriate BigPanda app key
- Content Type: Replace with: application/json
- Time of Day: No additional schedule for this action needed
- Executon Settings: Leave as Is
- Click Add Action.
- Click the Reset Actions step and then repeat steps 4 - 7, using the Reset Action template instead of the Trigger Action template.
- Click Next.
- Click Submit on the Summary page.
-
Assign actions to all desired alerts:
- 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.
- Select the Send to BigPanda - Trigger action and click Assign.
- Repeat for Assign Action > Assign Reset Action using the Send to BigPanda - Reset action.
Alert Template - Trigger Action
{
"app_key": "[INSERT_APP_KEY]",
"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}",
"solarwinds_object_id": "${N=Alerting;M=AlertObjectID}"
}
Alert Template - Reset Action
{
"app_key": "[INSERT_APP_KEY]",
"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}",
"solarwinds_object_id": "${N=Alerting;M=AlertObjectID}",
"reset": true
}
Uninstall the Integration
Deleting an integration requires changes to both the integrated system and BigPanda. You must uninstall the integration on the integrated system and then delete the integration from BigPanda.
When replacing an existing integration with a new tool or system, we recommend configuring the new integration first to ensure no data is lost.
Stop Sending Data to BigPanda
To uninstall the integration use the BigPanda SolarWinds Installer utility to automatically remove the BigPanda configuration from SolarWinds.
- Run the BigPanda SolarWinds installer tool.
- This must be run on either the SolarWinds server or another machine that has network access to the SolarWinds server.
- Fill in the details for your SolarWinds server and account.
- 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.
Manually resolve any open alerts sent from the integration to remove the associated incidents from your incident feed. These incidents will not automatically resolve without an ok
status from the original sending integration.
Delete the Integration from BigPanda
- In BigPanda, navigate to the Integrations tab and select the desired integration from the list.
- In the integration details on the right, click Delete Integration. A support message opens, pre-populated with a request to delete the selected integration.
- Press Enter to send the request.
- The BigPanda support team will remove the integration from the UI.
️
This procedure does not remove any data from BigPanda or the integrated system. As needed, remove data from each system before deleting the integration.
Updated 7 months ago