Skip to content

Alerting with PagerDuty

Estimated time to read: 4 minutes

This page shows how to set up and use EraSearch alerting with PagerDuty.

PagerDuty and EraSearch integration benefits

  • Notify on-call responders of alerts sent from EraSearch.
  • Send custom alert details to PagerDuty, including names, descriptions, and queries.

How it works

In the EraSearch UI, you configure alert rules to send alerts to PagerDuty. Here's the general workflow for alerting:

  1. Data in EraSearch meets a configured threshold.
  2. EraSearch sends an event to the relevant PagerDuty service.
  3. EraSearch's event triggers a new incident on the PagerDuty service, or PagerDuty groups the event into an existing incident.

Requirements

The steps below assume you have an EraCloud account. To set up an account, visit the getting started series.

Support

If you need help with this integration, reach out to us at Era Software.

Integration walkthrough

In PagerDuty

The sections below describe two ways to integrate a PagerDuty service with EraSearch.

Adding EraSearch to an existing PagerDuty service

  1. In PagerDuty, click the Services tab and then click the name of the service you want to configure.
  2. Click Integrations > Add an integration.
  3. Select the EraSearch integration and click Add to return to the integrations tab.
  4. Next to your new EraSearch integration, click the downward-facing arrow and copy the Integration Key. You'll use the key to configure EraSearch in the next section.

Creating a new PagerDuty service for EraSearch

  1. In PagerDuty, click the Services tab > New Service.
  2. Follow the steps in the UI, selecting the EraSearch integration in step 3.
  3. Click Create Service to view your new service and EraSearch integration.
  4. Copy the Integration Key. You'll use the key to configure EraSearch in the next section.

In EraSearch

Follow the steps below to configure an alert rule in EraSearch and send alerts to PagerDuty.

Step 1: Configure the PagerDuty notification channel

EraSearch sends alerts to notification channels. To create a PagerDuty notification channel, sign in to your EraCloud account and follow these steps:

  1. In the sidebar, click bell icon and then click Channels > + Add channel.
  2. Configure your notification channel:
    1. For Name, give your notification channel a name, for example, PagerDuty logs service.
    2. For Type, select PagerDuty.
    3. For Service key, enter the integration key you got in the section above.
  3. Click Test channel to check your configuration and get a sample event in PagerDuty.
  4. Click Save channel.

Step 2: Configure an alert rule to send alerts to PagerDuty

Follow these steps to configure and test your alert rule:

  1. In the Alerts tab, click Rules > + Add rule.
  2. Set the details for your alert rule:

    1. For Name, give a name that'll appear in the alert notification.

      Example: GET 404 errors.

    2. For Desc., add details you want to include in the alert notification.

      Example: Check backend services.

    3. For Query, enter a query using Elasticsearch's query-string syntax.

      Example: status:404 AND method:GET AND size:>3000.

  3. Set the conditions for your alert rule by selecting items in the IF, WITHIN, and NOTIFY drop-downs.

  4. Click Save rule to enable the alert rule.

Note that you can click the megaphone icon to mute and unmute your alert rule in the UI.

How to uninstall

To remove PagerDuty from EraSearch:

  1. Go to your EraCloud account and click bell icon.
  2. Under Alert rules, reroute all alerts using the PagerDuty notification channel to a different channel.
  3. Under Notification channels, click the relevant PagerDuty notification channel.
  4. Click Remove channel.

Next steps

Visit these pages for more on working with and exploring data in EraSearch:


Last update: October 6, 2022