Skip to main content
ComponentsEngine
Availability2017.1 or later

Create the BigPanda Integration

App Key, API key and endpoint

Create the GermainUX HTTP Action

Sending alerts over HTTP

Payload Fields and Severity

Deduplication and status mapping

Troubleshooting

Common errors and fixes

Overview

GermainUX sends alerts to BigPanda through a GermainUX HTTP Action that POSTs each SLA breach to the BigPanda Alerts API. BigPanda then deduplicates, correlates and prioritizes those alerts alongside your other monitoring sources. What you get:
  • GermainUX SLA breaches (failed transactions, slow responses, application errors, failed synthetic scenarios) appear as BigPanda alerts.
  • Each alert carries GermainUX context: KPI, SLA, severity, host and error details.
  • Repeat breaches of the same KPI and SLA collapse into one BigPanda alert instead of a stream of duplicates.

Architecture

Image When an SLA is breached, GermainUX runs the HTTP Action assigned to it. The action renders a JSON body from the alert context and POSTs it to the BigPanda Alerts API (HTTPS POST /data/v2/alerts), where it is deduplicated on KPI + SLA name and correlated into incidents. A repeat breach of the same KPI + SLA updates the existing BigPanda alert; an event with status ok resolves it.

Step 1: Create the Alerts REST API integration in BigPanda

1

Create the integration

In BigPanda, open Integrations, create a new integration and choose the Alerts REST API integration type.
2

Name the integration

Name it so the source is clear, for example GermainUX or GermainUX - Production.
3

Generate the App Key

Generate the integration’s App Key and copy it. Every alert GermainUX sends includes this value as app_key.
4

Get a User API Key

Create or copy a User API Key for the account that will send alerts. A dedicated service account is recommended.
5

Note your region's endpoint

For US-hosted organizations:
For EU-hosted organizations, use https://api.eu.bigpanda.io/data/v2/alerts. A successful request returns 201.

Step 2: Create the HTTP Action in GermainUX

Go to: GermainUX Workspace > Automation > HTTP Select the Add icon to open the HTTP Action wizard. The same wizard is available under Settings > Wizards > HTTP Action.

Configure the Action

Select Next.

Configure the HTTP Request

Request Body Template

The body is a FreeMarker template rendered against the SLA alert context:
Replace <BigPanda App Key> with the App Key from Step 1, and set source and environment to match the KPI. Use ?json_string on every value taken from the context, so quotes and line breaks in error details don’t break the JSON.

Step 3: Assign the HTTP Action to an SLA

1

Open the KPI you want to send to BigPanda

For example, a synthetic scenario KPI or an application error KPI.
2

Select or configure an SLA

Select an existing SLA on that KPI, or configure a new one with the breach condition you want to alert on.
3

Add the HTTP Action as the SLA Action

Add the Send Alert to BigPanda HTTP Action as the SLA’s SLA Action.
4

Repeat for every KPI and SLA that should reach BigPanda

One HTTP Action can be shared by many SLAs.
HTTP Actions can also run on a schedule, from a rule, or manually. For BigPanda, the SLA trigger is recommended because it supplies the context.sla and context.kpi values the template uses.

Step 4: Finish and Test

1

Confirm the Action Service can reach BigPanda

Before saving the action, send a test alert from the GermainUX server running the Action Service:
2

Complete the wizard, then run the HTTP Action manually from the Workspace and confirm it reports success

3

In BigPanda, confirm the alert appears on the integration and opens an incident

4

Force a controlled SLA breach on a test KPI and confirm the alert arrives with the right KPI, SLA, host, status and description

5

Trigger the same breach again and confirm BigPanda updates the existing alert instead of creating a new one

6

Confirm the API key does not appear in GermainUX logs or notifications

7

Assign the action to production SLAs

Payload Fields and Severity Mapping

BigPanda deduplicates alerts on the fields named in primary_property and secondary_property. The template uses the KPI name and SLA name, so repeat breaches of the same SLA update one BigPanda alert.

Severity Mapping

BigPanda accepts four status values. The template sets status from context.sla.severity.ordinal(), where 0 is the most severe SLA level. Test the mapping before production.

Resolving Alerts in BigPanda

The HTTP Action sends an event when an SLA is breached. A BigPanda alert resolves when it receives an event with "status": "ok" and the same kpi and check values. Choose one of these approaches:
  • Resolve in BigPanda: operators resolve the incident in BigPanda once the issue is fixed.
  • Send an ok event from GermainUX: create a second HTTP Action with the same body and "status": "ok", and attach it to an SLA or rule that fires when the KPI recovers.
  • Resolve through the BigPanda API: call the Resolve Alerts endpoint with the BigPanda alert IDs (up to 500 alerts per request, one request per second).

Troubleshooting

References

GermainUX

BigPanda

Get Help

Contact GermainUX Support

The Germain Team can help you set this up.

Can't find what you need?

Search all GermainUX docs with Ctrl + K, or use the feedback buttons at the bottom of this page to tell us what is missing.

The content of this document is proprietary to GERMAIN SOFTWARE.