laravel-notification-channels/pagerduty

A Laravel notification channel for sending PagerDuty events.

0.4.0 2021-01-14 23:08 UTC

Requires

• php: >=7.1
• guzzlehttp/guzzle: ~6.0|^7.0
• illuminate/notifications: ~5.5 || ~6.0 || ~7.0 || ^8.0
• illuminate/support: ~5.5 || ~6.0 || ~7.0 || ^8.0

Requires (Dev)

• illuminate/queue: ~5.5 || ~6.0 || ~7.0 || ^8.0
• mockery/mockery: ^1.2
• phpunit/phpunit: ^8.5|^9.0

MIT

• Luke Waite

• notifications
• laravel
• alerting
• PagerDuty
• laravel-package
• notification-channel

README

This package makes it easy to send notification events to PagerDuty with Laravel 5.5+, 6.x and 7.x

Contents

• Installation
  • Setting up the PagerDuty service
• Usage
  • PagerDuty Setup
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require laravel-notification-channels/pagerduty

Usage

Now you can use the channel in your via() method inside the Notification class.

use NotificationChannels\PagerDuty\PagerDutyChannel;
use NotificationChannels\PagerDuty\PagerDutyMessage;
use Illuminate\Notifications\Notification;

class SiteProblem extends Notification
{
    public function via($notifiable)
    {
        return [PagerDutyChannel::class];
    }

    public function toPagerDuty($notifiable)
    {
        return PagerDutyMessage::create()
            ->setSummary('There was an error with your site in the {$notifiable->service} component.');
    }
}

In order to let your Notification know which Integration should receive the event, add the routeNotificationForPagerDuty method to your Notifiable model.

This method needs to return the Integration Key for the service and integration to which you want to send the event.

public function routeNotificationForPagerDuty()
{
    return '99dc10c97a6e43c387bbc4f877c794ef';
}

PagerDuty Setup

On a PagerDuty Service of your choice, create a new Integration using the Events API v2.

The Integration Key listed for your new integration is what you need to set in the routeNotificationForPagerDuty() method.

Available Message methods

• resolve(): Sets the event type to resolve to resolve issues.
• setDedupKey(''): Sets the dedup_key (required when resolving).
• setSummary(''): Sets a summary message on the event.
• setSource(''): Sets the event source; defaults to the hostname.
• setSeverity(''): Sets the event severity; defaults to critical.
• setTimestamp(''): Sets the timestamp of the event.
• setComponent(''): Sets the component of the event.
• setGroup(''): Sets the group of the event.
• setClass(''): Sets the class.
• addCustomDetail('', ''): Adds a key/value pair to the custom_detail of the event.

See the PagerDuty v2 Events API documentation for more information about what these options will do.

Usage

Notification::route('PagerDuty', '[my integration key]')->notify(new BasicNotification);

When using Notification::route be sure to reference 'PagerDuty' as the Channel.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Luke Waite
• All Contributors

License

The MIT License (MIT). Please see License File for more information.