PagerDuty

Overview

Firefly integrates with PagerDuty to provide real-time notifications for critical infrastructure events, policy violations, and other important alerts. This integration enables teams to receive immediate notifications and manage incidents effectively through PagerDuty's incident management platform.

When integrating with PagerDuty, you have two primary methods:

• Integration Key

• General Access REST API Key

Prerequisites

• A PagerDuty account with administrative access

• Appropriate permissions to generate integration keys or API keys

• A configured PagerDuty service for receiving notifications

Setup Procedure

Integration Key (Recommended Method)

Use this method for optimal integration with a specific PagerDuty service.

1. Generate an Integration Key:

   • Visit the PagerDuty documentation

   • Follow the instructions to generate a new integration key

   • Copy the Integration Key

2. In Firefly:

   • Select Settings > Integrations

   • Select Add New > PagerDuty

   • Enter a descriptive name in the Nickname field

   • Select Integration Key from the Integration Type field

   • Paste the Integration Key in the Key box

   • Select Next

General Access REST API Key

Use this method to generate notifications for all services available in your PagerDuty account.

Note: For optimal integration, we recommend using an Integration Key instead.

1. Generate a Read-Only REST API Key:

   • Visit the PagerDuty documentation

   • Follow the instructions to generate a general access REST API key

   • Copy the API key

2. In Firefly:

   • Select Settings > Integrations

   • Select Add New > PagerDuty

   • Enter a descriptive name in the Nickname field

   • Select General Access REST API Key from the Integration Type field

   • Paste the API key in the Key field

   • Select Next

Features Enabled

• Real-time Incident Creation: Automatically create PagerDuty incidents for critical events

• Service-specific Routing: Direct notifications to specific PagerDuty services

• Rich Incident Details: Include comprehensive information in incident descriptions

• Automated Resolution: Close incidents when issues are resolved in Firefly

• Priority Management: Set appropriate incident priorities based on event severity

Best Practices

• Use Integration Keys for service-specific notifications

• Configure appropriate incident priorities and escalation policies

• Set up proper notification rules to avoid alert fatigue

• Regularly review and update integration settings

• Ensure proper permissions are set for API keys

Troubleshooting

1. For Integration Key issues:

   • Verify the key is valid and not expired

   • Check service configuration in PagerDuty

   • Ensure the service is active and properly configured

2. For API Key issues:

   • Verify the API key has appropriate permissions

   • Check if the key is still valid

   • Confirm the key hasn't been revoked

3. For notification issues:

   • Review notification rules in Firefly

   • Check PagerDuty service settings

   • Verify incident creation permissions