Integrations Overview
BigPanda provides several types of integrations that allow you to receive data from your Ops tools and share information with your collaborators through other systems.
Prerequisites
Relevant Permissions
Roles with the following permissions can access the BigPanda Integrations tab:
Role Name | Description |
---|---|
Integrations_Read | Read-only - view BigPanda Integrations in the BigPanda Integrations tab. |
Integrations_Full_Access | Full access - view, install, uninstall and/or work with integrations in the BigPanda Integrations tab. |
To learn more about how BigPanda's permissions work, see the RBAC - Role Based Access Control guide.
Types of Integrations
BigPanda offers several types of integrations:
-
Monitoring: allows BigPanda to receive alerts from your monitoring systems, such as Nagios, SolarWinds, and AppDynamics. Many users start by integrating these systems.
-
Collaboration: allows you to share incidents from BigPanda with your co-workers through other systems. For example, open JIRA tickets or send Slack notifications.
-
Changes: allows BigPanda to receive change notifications from your change systems, such as CloudTrail, Jenkins, ServiceNow, and Jira.
-
Topology: allows you to enrich alerts coming into BigPanda with topology information from configuration management, cloud and virtualization management, service discovery, APM, and CMDB tools.
Agent vs. Webhook Integrations
BigPanda supports both on-premise and SaaS monitoring tools through different mechanisms.
Many on-premise tools are integrated using the BigPanda agent. The agent is a low-footprint daemon installed on the master host of your monitoring tool. It consumes alerts from the tool in real time, and then transmits them to BigPanda via SSL-encrypted HTTP calls.
Most SaaS tools (such as CloudWatch or New Relic) are integrated using Webhooks. Whenever the SaaS tool generates an alert, it posts an HTTP message directly to BigPanda. BigPanda listens to incoming messages and processes them.
To learn more about using the agent, see the BigPanda Agent documentation.
Available OOTB Integrations
Monitoring
Product | Supported Versions | Type | Authentication Type | |
---|---|---|---|---|
Airbrake | SaaS Deployments (Deprecated) | Webhook | ||
SaaS and On-Premise Deployments | Webhook | Bearer Token | ||
4.1+; On-Premise, Dedicated SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
9.4.x | Spectrum Scripts | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | CloudFormation, Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
Dataloop.IO | SaaS Deployments (deprecated) | Webhook | Bearer Token | |
SaaS Deployments | Webhook | Bearer Token | ||
Grafana >= v5.0.0 | Webhook | Bearer Token | ||
1, 2 | Agent | Bearer Token | ||
Librato | SaaS Deployments | Webhook | Bearer Token | |
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
System Center 2012 R2 and 2016 | Webhook | Bearer Token | ||
3, 4 | Agent | Bearer Token | ||
4, 5 | Agent | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
Nagios-Compatible Versions (Version 5 and older) | Agent | Bearer Token | ||
Panopta | SaaS Deployments (Depreciated) | Webhook | ||
SaaS Deployments | Webhook | Bearer Token | ||
Alertmanager >= v0.16.0 | Webhook | Bearer Token | ||
14.4+; English Language (Only) | Webhook | Bearer Token | ||
Scout | SaaS Deployments (Deprecated) | Webhook | ||
SasS Deployments | Webhook | Bearer Token | ||
0.12+ | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
v1, v2, v2c | Daemon and Agent | Bearer Token | ||
Orion Server, Versions 2015.1+; Network Performance Monitor (NPM) 10.4+ | Webhook | Bearer Token | ||
4+; On-Premise; Cloud | Native App (v6.3+) | Bearer Token | ||
StatusCake | SaaS Deployments (Deprecated) | Webhook | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
SaaS Deployments | Webhook | Bearer Token | ||
2.2, 3.0, 3.2 | Agent | Bearer Token | ||
Zenoss Core 4, 5, 6 | Agent | Bearer Token |
Collaboration
Product | Supported Versions | Type | Authentication Type |
---|---|---|---|
Asana | SaaS Deployments | API | API Key |
JIRA | 6+ | API | API Key and Bearer Token |
OpsGenie | SaaS Deployments | API | API Key |
PagerDuty | SaaS Deployments | API | Bearer Token |
ServiceNow | New York, Madrid, London, Kingston, Jakarta, Istanbul, Helsinki, Geneva, Fuji | API | API Key and Bearer Token |
Slack | SaaS Deployments | API | Bearer Token |
xMatters | 6+ | API | API Key |
️ Deprecated Features
The Airbrake, Panopta, Scout, and StatusCake integrations are no longer being updated and may be removed in a future product version. At this time, they are still available only to current users of those integrations. If you are using these integrations, consider building a custom integration with the Alerts API. Please contact BigPanda support at [email protected] with any questions or feedback.
Root Cause Changes
Product | Supported Versions | Type | Authentication Type |
---|---|---|---|
CloudTrail | SaaS | API | API Key |
Jenkins | 1.546 or later | Native Plugin, Webhook | API Key |
Jira - Changes | Jira Cloud, Jira Server | Native App, Webhook | API Key and Bearer Token |
ServiceNow | New York, Madrid, London, Kingston, Jakarta, Istanbul, Helsinki, Geneva, Fuji | Native App, API | API Key and Bearer Token |
Topology
Product | Supported Versions | Type | Authentication Type |
---|---|---|---|
Datadog Topology | Bearer Token | ||
Dynatrace Topology | SaaS Deployments | API | Bearer Token |
ServiceNow | Orlando, New York, Madrid, London, Kingston, Jakarta, Istanbul, Helsinki, Geneva, Fuji | Native App, API | API Key and Bearer Token |
vCenter Inventory | vCenter Server 6.5 update 2 and newer | Native Plugin | Bearer Token |
Sample Custom Integration Recipes
️ Using Sample Code
These samples are meant to provide a helpful starting point for your custom integration. Though you may be able to copy some of the samples and use them without modifications, your system administrators must review and test all scripts and methods before using them, as per good practices.
Product | Product Version Described | BigPanda APIs Used |
---|---|---|
Integrating Logentries with BigPanda | SaaS version on July 14, 2016 | Alerts API |
Integrating Logz.io with BigPanda | SaaS version on Dec. 22, 2016 | Alerts API |
Integrating Sumo Logic with BigPanda | SaaS version on Feb. 3, 2016 | Alerts API |
Integrating LogicMonitor with BigPanda | SaaS | Alerts API |
Integrating API Fortress | On-Premise Deployments; SaaS | Alerts API |
Integrating Dataloop with BigPanda | SaaS version on July 19, 2016 | Alerts API |
Integrating CA Spectrum with BigPanda | CA Spectrum Version 9.4.x | Alerts API |
Integrating Your First Monitoring Service
To get started, integrate your monitoring services with BigPanda. After integrating your services, you can see and manage your alerts from within the BigPanda interface.
Prerequisites
- Obtain a BigPanda account.
- (Recommended) Review the Integrations Overview.
Integrating a Monitoring Service
Administrators can install any of the available integrations in BigPanda.
- Log in to BigPanda, and click the Integrations tab at the top of the screen.
- In the left pane, click New Integration.
- Click the desired integration. The installation instructions open.
Finding Integrations
You can filter the list of available integrations by clicking the Monitoring tab in the top left or by entering a search term in the top right. If you don't see the tool you use, consider using the Alerts REST API or contact BigPanda support.
- Follow the instructions to install and configure your integration.
Checking the Status of Integrations
- At the top of the screen, click the Integrations tab. The left pane shows the name and recent activity for each installed integration.
️ Multiple Integrations For A Single System
If you’ve configured multiple integrations of the same type, each integration is listed separately in the left pane.
- (Optional) Filter the list of installed integrations by entering a search term.
- Review the colored ribbons on the left of each listing to check the status of your integrations.
- Pending (orange indicator): The integration has been configured but no data has been received from it yet. The source system may not have generated alerts yet, or the integration may not be configured correctly.
- Installed (green indicator): The integration is working properly.
- Click the desired integration. The integration details appear in the right pane.
Renaming Integrations
To rename the integration, click Edit Name beside its name. Then, enter the new name up to 20 characters long, and press Enter.
- If the integration is pending but the source system has generated alerts since you integrated it, click Review Instructions and ensure it is configured correctly.
- If you receive error indicators on your integration tiles, review the information presented in the Troubleshooting log and troubleshoot your errors to resolve the issues within your integrated system.
Contact BigPanda support for more help, if needed.
Post-Requisites
Manage Incidents using Incident Feed.
Deleting an Integration
You may want to remove an integration that you have installed in BigPanda. For example, when you are upgrading to a new version or if your infrastructure changes. In general, 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.
Prerequisites
- 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.
- (Optional) Delete any shared data that was posted in the integrated system. For example, close any incident tickets opened by BigPanda in the target system.
Uninstalling an Integration
- On the integrated system, disable any settings that send events to BigPanda or receive shared data from BigPanda.
️
Each system requires specific changes to disable the integration with BigPanda. For example, you must delete the topic in CloudWatch, and you must disable the alert channel in New Relic. To determine the changes for your integrated system, reference the relevant documentation or contact BigPanda support.
- If the integration is agent-based, uninstall the agent from the server.
Deleting An Integration From BigPanda
Administrators can request permanent deletion of existing integrations from the BigPanda 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.
- In BigPanda, click the Integrations tab at the top of the screen.
- (Optional) Filter the list of installed integrations by entering a search term.
- Click the integration you want to delete.
- In the right pane, click Delete Integration. The message window opens and is 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.
Reference: Integrations Tab
Use this reference guide to quickly find out what each item on the Integrations tab means, then follow the links to learn more about a feature.
Integrations Tab
The Integrations tab provides a centralized place to manage your integrations with BigPanda.
Item | Description | Related Links |
---|---|---|
Left Pane | Lists basic information about each installed integration and provides a filter to search for a specific integration. | - Integrating Your First Monitoring Service - Available Integrations |
Information Center | (No integration selected) Provides links to helpful information about BigPanda. | Getting Help |
Integration Details | (Integration selected) Shows detailed information about the integration selected in the left pane. You can see the status, review the configuration instructions, change the name, or delete the integration. | - Integrating Your First Monitoring Service - Deleting an Integration |
Integrations List Item
Item | Description | Related Links |
---|---|---|
Status Indicator | Displays a colored ribbon on the left to indicate the status of the integration, which is determined by whether data has been received from or sent to the integrated system. | |
System | Shows the integration type (such as Nagios or Zabbix). | |
Name | Shows the integration name (such as Production). | |
Activity Summary | Shows a summary of recent activity for the integration:
|
Integration Details
Item | Description | Related Links |
---|---|---|
Status Indicator | Displays a colored ribbon on the left to indicate the status of the integration, which is determined by whether data has been received from or sent to the integrated system. | |
System | Shows the integration type (such as Nagios or Zabbix). | |
Name | Shows the integration name (such as Production). You can change the name of an installed integration. | |
App Key | Shows the unique identifier for the integration, if applicable. | |
Activity History | Shows the activity history, depending on the integration type and status:
| |
Review Instructions | Opens the installation instructions for the integration. | |
Created | Shows the date the integration was installed. | |
Delete Integration | Allows you to send a request to delete the selected integration. |
Creating a New Integration
Item | Description | Related Links |
---|---|---|
Tabs | Filters the list of available integrations by type. | Integrating Your First Monitoring Service |
Search | Filters the list of available integrations by the search term. Enter the name of your tool to find it quickly. | Integrating Your First Monitoring Service |
Available Integrations | Shows all available integrations that match the selected tab and the search term. Select an integration to open the installation instructions. | Available Integrations |
Updated 5 days ago