Overview#
You can configure PagerDuty integration to create and monitor events for file transfer tasks and device status changes.
After completing the integration, an event (alert or incident) is automatically created in PagerDuty whenever designated events occur, such as a transfer being Started (Transfer Started) or Completed (Transfer Completed), or a device being Connected (Device Connected) or Disconnected (Device Disconnected).
The entire process consists of two steps: ① Obtain an Integration Key → ② Configure the integration in the product.
Prerequisites#
Before you begin, check the following.
| Item | Description |
|---|---|
| PagerDuty account | A PagerDuty account with permission to add an Events API V2 Integration to a service is required. |
| Target service | Prepare the PagerDuty service that will receive events. |
| Network | Outbound HTTPS communication to events.pagerduty.com (443) must be available from the environment where the product is installed. |
Obtain a PagerDuty Integration Key#
To send events to PagerDuty, add an Events API V2 Integration to the service and obtain an Integration Key (Routing Key).
Step 1. Add an Events API V2 Integration#
In PagerDuty, go to Services → Service Directory, then select the target service or create a new service.
In the service's Integrations tab, click Add Integration and select Events API V2.
Step 2. Check the Integration Key#
In the Integrations tab, copy the Integration Key (Routing Key) of the Integration you created.
ℹ️ An Integration Key has the same level of access as a password, so make sure it is not exposed in public repositories or external documents. If it is exposed, generate a new key through Edit Integration → Generate a new Integration Key.
Checklist#
- ✔ An Events API V2 Integration has been added.
- ✔ The Integration Key has been copied.
Configure PagerDuty Integration#
Enter the issued Integration Key in the product.
When you open the Monitoring settings window, the following screen is displayed.
Step 1. Enter the Integration Key#
Enter the issued Integration Key in the Integration Key (Routing Key) field.
Step 2. Select Events#
Select the events to monitor under Events.
You can select multiple events, and events are created in PagerDuty only when the selected events occur.
| Event | When It Occurs |
|---|---|
| Transfer Started | When the transfer task starts |
| Transfer Completed | When the transfer task is completed successfully |
| Transfer Paused | When the transfer task is temporarily paused |
| Transfer Recovered | When the transfer is automatically recovered and resumed after an interruption or error |
| Device Connected | When a device is connected |
| Device Disconnected | When a device is disconnected |
Step 3. Save the Settings#
After completing the input, click Add to save the integration.
Checklist#
- ✔ The Integration Key has been entered.
- ✔ The events to monitor have been selected.
Verify the Integration#
Verify that the settings are working correctly.
Step 1. Trigger a Test Event#
Run an actual transfer task or trigger one of the selected events.
Step 2. Check PagerDuty#
Check whether an event or incident has been created in the PagerDuty service that issued the Integration Key.
Checklist#
- ✔ An event has been created in PagerDuty.
- ✔ The triggered event was delivered successfully.
Setup Complete#
Once the settings are saved, the integration is applied.
After that, an event is automatically created in PagerDuty whenever the selected events occur.
Troubleshooting#
| Issue | Checklist |
|---|---|
| An event is not created | Check whether the Integration Key is correct and whether there are leading or trailing spaces or missing characters. |
| An authentication error occurs | Check whether the key is the Integration Key for the Events API V2 Integration and has not been regenerated. |
| Does not work in the EU region | Check whether an EU region account is using the events.eu.pagerduty.com endpoint. |
| Connection fails | Check whether events.pagerduty.com (443) or the EU endpoint is allowed by the firewall or proxy. |