Support PagerDuty immigration for alarm

[wu-sheng]

PagerDuty(https://www.pagerduty.com/) is widely used for on-call globally. We are welcome the contributions to support it as alarm notification channel.

[harry-dev98]

hey, I am kinda new to this community. I'd like to head with this issue to start contributing, can you please share bit of more information what is the requirement of this issue?

[wu-sheng]

@harry-dev98 Thanks. We have various notifications, from webhook to slack. PageDuty seems a very important channel to forward the alarm.

https://skywalking.apache.org/docs/main/latest/en/setup/backend/backend-alarm/#webhook

The source codes about the existing notification implementations are here, https://github.com/apache/skywalking/tree/master/oap-server/server-alarm-plugin/src/main/java/org/apache/skywalking/oap/server/core/alarm/provider.

[harry-dev98]

Okay this is what i understand:
So we do have couple of channels already like webhook, gRPChook, slackhook,.. etc. And now we need to add pagerduty as another new channel supported by skywalking, right?

also, is pagerduty opensource? I looked through their website its kinda paid service (yes free for some caped usage)

[wu-sheng]

It is not open source. But once it has open HTTP API, we could try to integrate.
This is totally optional, and rarely changed API.
Please check whether this is correct.

[harry-dev98]

regarding APIs, yes pagerduty provides REST APIs. Basically two types of APIs one for managing the account other for events generated by some tool like skywalking,etc. So should i try integrating events api for now, and lateron can be extended to other type of API i.e. to manage account.

We just need to make sure the alarm notifications reach pagerduty account of the user, right?

[wu-sheng]

So should i try integrating events api for now, and lateron can be extended to other type of API i.e. to manage account.

Yes, try event APIs. And we may not need to spend time on account management APIs. As we don't have UI or feature about this. Only if you want to provide some scripts to create or set up account, then those APIs help.

We just need to make sure the alarm notifications reach pagerduty account of the user, right?

Yes, you could create a trial account, and make sure the alarm messages landed there.

[Superskyyy]

Hey there, just curious about the progress. Back when this issue was first created, I actually set up a PagerDuty developer account and a mock integration to try the implementation. Now PagerDuty people actually reached out to me asking about if SkyWalking would like to list the integration officially on their website. If there's no Apache regulations against it, I think we should do it when this merges. FYI @wu-sheng @harry-dev98

From my experience, PagerDuty is extremely popular and widely used among companies worldwide, I believe this is a good step to expand our community globally.

[wu-sheng]

@Superskyyy Good to know they are listing this. I read the list page, which seems fine from policy perspective.
Before that, we need this feature ready and released, then we at least have a version mentioned on their page.

[wu-sheng]

@harry-dev98 Do you have any update to share?

[wu-sheng]

Or @Superskyyy Do you already have codes of this feature ready to submit? 8.8.0 release is closing, 8.9.0 could be on Nov. or Dec. So you any of you have this feature ready, I would love to include this in the 8.8.0 release.

[Superskyyy]

Or @Superskyyy Do you already have codes of this feature ready to submit?

@wu-sheng Nah, I simply tested with its APIs on the mock integration, I didn't add anything to SW codebase. I'll say lets wait a day or two for Harry's response, if no response I can do it and if goes smoothly we can release it next month. We plan to release 8.8.0 after Oct.10th right?

[wu-sheng]

Yes, that is the current plan.