Skip to main content

PagerDuty

DBmarlin can send alert notifications to PagerDuty.

info

The PagerDuty integration requires v3.7 of DBmarlin.

Configuration within PagerDuty

DBmarlin will use the Event API v2 to send data to PagerDuty.

Since the configuration on the DBmarlin side only allows for a single PagerDuty integration key, we suggest that you use the Event Orchestration feature of PagerDuty. You can create a "DBmarlin" Event Orchestration and use the integration key of that to send your events to. Then on the PagerDuty side you can map to PagerDuty Services within the rules of your Orchestration by using fields within the event.

Create an Event Orchestration

You can setup a "DBmarlin" Event Orchestration within PagerDuty like this.

PagerDuty Event Orchestration

Copy the integration key and HTTP Endpoint for API

You can copy your Integration key from the Integrations tab and also the HTTP Endpoint for API which are the 2 fields needed by DBmarlin in order to send an event.

PagerDuty Event Orchestration configuration

Setup Service Routes

Using Service Routes you can map the incoming events to Services within PagerDuty. You can use fields within the incoming event such as event.source, event.component, event.group and event.class to route events to Services.

For example a Host CPU might have the following event properties:

  • Summary:
  • Source: dbhost01.acme.com
  • Component: linux
  • Group: Host
  • Class: statistic

And a Database Wait time alert might have the following event properties:

  • Summary: Postgres11 Wait Time alert for postgres11-postgresql
  • Source: postgres11-postgresql
  • Component: postgresql
  • Group: Datasource
  • Class: activity

These fields can be used to map different events to Services.

PagerDuty Service Routes

Configuration in DBmarlin Settings

To setup alert notifications to PagerDuty on the DBmarlin side, click Integrations and then Edit on the PagerDuty integration.

DBarlin PagerDuty Setting

You can add a new integration or edit to change an existing one. Note that you can only have one PagerDuty integration defined.

  • The URL will be the HTTP Endpoint for API will usually be https://events.pagerduty.com/v2/enqueue
  • The API key will be the integration key
  • The DBmarlin URL will be the URL you use to access DBmarlin. This is used for clicking back into DBmarlin from inside PagerDuty alerts.
  • You can optionally enable or disable the integration.

DBarlin PagerDuty Edit Setting

Receiving notifications

Once configured you should need new alerts arrive in PagerDuty. If you defined Service Routes to map them to Services then you may also get Incidents triggered.

Here is an example alert triggered by DBmarlin. There is a link at the bottom to click back into DBmarlin to see more details.

PagerDuty DBmarlin example Datasource alert