You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by GitBox <gi...@apache.org> on 2022/11/15 12:20:39 UTC
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #318: [feat-317]: Pagerduty docs + Singer doc revisions
Startrekzky commented on code in PR #318:
URL: https://github.com/apache/incubator-devlake-website/pull/318#discussion_r1022706137
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
+description: >
+ Pagerduty Plugin
+---
+
+
+
+## Summary
+
+This plugin collects all incidents from Pagerduty, and uses them to compute incident-type DORA metrics.
Review Comment:
How about:
"..., and uses them to compute DORA metrics such as [Median Time to Restore Service](https://devlake.apache.org/docs/Metrics/MTTR) and [Change Failure Rate](https://devlake.apache.org/docs/Metrics/CFR)."
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
Review Comment:
Shall we use PagerDuty here?
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
+description: >
+ Pagerduty Plugin
+---
+
+
+
+## Summary
+
+This plugin collects all incidents from Pagerduty, and uses them to compute incident-type DORA metrics.
+
+As of v0.15.0, the `pagerduty` plugin can only be invoked through the DevLake API. Its support in Config-UI is WIP.
+
+
+## Usage via DevLake API
+
+> Note: Please replace the `http://localhost:8080` in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of [Developer Setup](../DeveloperManuals/DeveloperSetup.md).
+
+
+1. Create a Pagerduty data connection: `POST /plugins/pagerduty/connections`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/plugins/pagerduty/connections' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "name": "pagerduty-test1",
+ "endpoint": "https://api.pagerduty.com",
+ "token": "<api-access-token>"
+}'
+```
+
+2. Create a blueprint to collect data from Pagerduty: `POST /blueprints`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/blueprints' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "cronConfig": "manual",
+ "enable": true,
+ "isManual": true,
+ "mode": "NORMAL",
+ "name": "test-blueprint",
+ "settings": {
+ "connections": [
+ {
+ "connectionId": 1,
+ "plugin": "pagerduty",
+ "scope": [
+ {
+ "entities": [
+ "TICKET"
+ ],
+ "options": {
+ "connectionId": 1,
+ "start_date": "2022-06-01T15:04:05Z"
+ }
+ }
+ ]
+ }
+ ],
+ "version": "1.0.0"
+ }
+}'
+```
+
+Here `start_date` is the time sinch which all created incidents will be collected.
+
+3. [Optional] Trigger the blueprint manually: `POST /blueprints/{blueprintId}/trigger`. Run this step if you want to trigger the newly created blueprint right away. See an example request below:
+
+```
+curl --location --request POST 'http://localhost:8080/blueprints/<blueprintId>/trigger' \
+--header 'Content-Type: application/json'
+```
Review Comment:
I suggest adding another paragraph here to tell users what to do next.
Example 1: You can find the incidents in table.issues in MySQL with a condition `type = 'INCIDENT'`.
Example 2: You can go to Grafana to visit the DORA dashboard. Note that `deployments` also need to be collected before you can see the metrics. You can collect `deployments` via [Jenkins](https://devlake.apache.org/docs/Plugins/jenkins), [GitHub](https://devlake.apache.org/docs/Plugins/github)(GitHub Action jobs), [GitLab](https://devlake.apache.org/docs/Plugins/gitlab)(GitLab CI jobs), or [incoming webhooks](https://devlake.apache.org/docs/Plugins/webhook).
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
+description: >
+ Pagerduty Plugin
+---
+
+
+
+## Summary
+
+This plugin collects all incidents from Pagerduty, and uses them to compute incident-type DORA metrics.
+
+As of v0.15.0, the `pagerduty` plugin can only be invoked through the DevLake API. Its support in Config-UI is WIP.
Review Comment:
How about using `v0.15.x`? As we might release patch versions.
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
+description: >
+ Pagerduty Plugin
+---
+
+
+
+## Summary
+
+This plugin collects all incidents from Pagerduty, and uses them to compute incident-type DORA metrics.
+
+As of v0.15.0, the `pagerduty` plugin can only be invoked through the DevLake API. Its support in Config-UI is WIP.
+
+
+## Usage via DevLake API
+
+> Note: Please replace the `http://localhost:8080` in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of [Developer Setup](../DeveloperManuals/DeveloperSetup.md).
+
+
+1. Create a Pagerduty data connection: `POST /plugins/pagerduty/connections`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/plugins/pagerduty/connections' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "name": "pagerduty-test1",
+ "endpoint": "https://api.pagerduty.com",
+ "token": "<api-access-token>"
+}'
+```
+
+2. Create a blueprint to collect data from Pagerduty: `POST /blueprints`. Please see a sample request below:
+
+```
+curl --location --request POST 'http://localhost:8080/blueprints' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+ "cronConfig": "manual",
+ "enable": true,
+ "isManual": true,
+ "mode": "NORMAL",
+ "name": "test-blueprint",
+ "settings": {
+ "connections": [
+ {
+ "connectionId": 1,
+ "plugin": "pagerduty",
+ "scope": [
+ {
+ "entities": [
+ "TICKET"
Review Comment:
Do we need to add a link to a doc here to explain what entities are and their possible values?
##########
docs/Plugins/pagerduty.md:
##########
@@ -0,0 +1,74 @@
+---
+title: "Pagerduty (WIP)"
+description: >
+ Pagerduty Plugin
+---
+
+
+
+## Summary
+
+This plugin collects all incidents from Pagerduty, and uses them to compute incident-type DORA metrics.
+
+As of v0.15.0, the `pagerduty` plugin can only be invoked through the DevLake API. Its support in Config-UI is WIP.
+
+
+## Usage via DevLake API
+
+> Note: Please replace the `http://localhost:8080` in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of [Developer Setup](../DeveloperManuals/DeveloperSetup.md).
+
+
+1. Create a Pagerduty data connection: `POST /plugins/pagerduty/connections`. Please see a sample request below:
Review Comment:
PagerDuty
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org