This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 9f8c21b37b doc-495: PagerDuty doc update (#514)
9f8c21b37b is described below
commit 9f8c21b37be5657a5fb1d8ad851f014443cb0c84
Author: Keon Amini <[email protected]>
AuthorDate: Sat May 6 09:49:31 2023 -0500
doc-495: PagerDuty doc update (#514)
---
docs/Configuration/PagerDuty.md | 57 ++++++++++++++++
.../images/pagerduty-add-data-connection.png | Bin 0 -> 21282 bytes
.../images/pagerduty-create-a-connection.png | Bin 0 -> 27379 bytes
.../images/pagerduty-set-data-scope.png | Bin 0 -> 21967 bytes
.../Configuration/images/pagerduty-sync-policy.png | Bin 0 -> 41409 bytes
docs/Plugins/pagerduty.md | 76 +++------------------
6 files changed, 66 insertions(+), 67 deletions(-)
diff --git a/docs/Configuration/PagerDuty.md b/docs/Configuration/PagerDuty.md
new file mode 100644
index 0000000000..7882235266
--- /dev/null
+++ b/docs/Configuration/PagerDuty.md
@@ -0,0 +1,57 @@
+---
+title: "PagerDuty"
+sidebar_position: 4
+description: Config UI instruction for PagerDuty
+---
+
+Visit Config UI at: `http://localhost:4000`.
+
+## Step 1 - Add Data Connections
+
+
+
+### Connection Name
+
+Give your connection a unique name to help you identify it in the future.
+
+### Token
+
+Paste your PagerDuty personal access token (PAT) here. You may make it a
Read-Only token for the plugin's purposes.
+
+### Test and Save Connection
+
+Click `Test Connection`, if the connection is successful, click `Save
Connection` to add the connection.
+
+## Step 1 - Add Data Connection
+
+Create a project for PagerDuty by adding the connection created above to it.
+
+
+
+## Step 2 - Setting Data Scope
+
+### Select services
+
+Select the services you want to collect data from.
+
+
+
+### Data Entities
+
+PagerDuty supports the following data entities.
+
+- Issue Tracking: These map to PagerDuty incidents.
+
+## Step 3 - Adding Transformation Rules (Optional)
+
+Currently, this plugin does not support transformation rules, so skip this
page by clicking `Next Step`.
+
+## Step 4 - Set Sync Policy
+
+Set the sync policy as you see fit. Note that PagerDuty can only collect data
from up to 6 months prior to the present time.
+
+
+
+## Troubleshooting
+
+If you run into any problem, please check the
[Troubleshooting](/Troubleshooting/Configuration.md) or [create an
issue](https://github.com/apache/incubator-devlake/issues)
diff --git a/docs/Configuration/images/pagerduty-add-data-connection.png
b/docs/Configuration/images/pagerduty-add-data-connection.png
new file mode 100644
index 0000000000..92af389dfa
Binary files /dev/null and
b/docs/Configuration/images/pagerduty-add-data-connection.png differ
diff --git a/docs/Configuration/images/pagerduty-create-a-connection.png
b/docs/Configuration/images/pagerduty-create-a-connection.png
new file mode 100644
index 0000000000..bb861b6e86
Binary files /dev/null and
b/docs/Configuration/images/pagerduty-create-a-connection.png differ
diff --git a/docs/Configuration/images/pagerduty-set-data-scope.png
b/docs/Configuration/images/pagerduty-set-data-scope.png
new file mode 100644
index 0000000000..4dcc3c76aa
Binary files /dev/null and
b/docs/Configuration/images/pagerduty-set-data-scope.png differ
diff --git a/docs/Configuration/images/pagerduty-sync-policy.png
b/docs/Configuration/images/pagerduty-sync-policy.png
new file mode 100644
index 0000000000..6155fb4c40
Binary files /dev/null and
b/docs/Configuration/images/pagerduty-sync-policy.png differ
diff --git a/docs/Plugins/pagerduty.md b/docs/Plugins/pagerduty.md
index 485c6cce40..dce17e8d0f 100644
--- a/docs/Plugins/pagerduty.md
+++ b/docs/Plugins/pagerduty.md
@@ -1,5 +1,5 @@
---
-title: "PagerDuty(WIP)"
+title: "PagerDuty"
description: >
PagerDuty Plugin
---
@@ -8,71 +8,13 @@ description: >
## Summary
-This plugin collects all incidents from PagerDuty, and uses them to compute
incident-type DORA metrics. These include
-[Median time to restore service](/Metrics/MTTR.md) and [Change failure
rate](/Metrics/CFR.md).
+This plugin collects all incidents from PagerDuty, and uses them to compute
incident-type DORA metrics. Namely,
+* [Median time to restore service](/Metrics/MTTR.md)
+* [Change failure rate](/Metrics/CFR.md).
+* [Incident Age](/Metrics/IncidentAge.md)
+* [Incident Count Per 1k Lines of
Code](/Metrics/IncidentCountPer1kLinesOfCode.md)
-As of v0.15.x, 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. Entities may be blank: the only
-allowed entity is `"TICKET"` which will be used as default.
-
-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'
-```
-
-Note the incidents are extracted from the `issues` table in MySQL with the
condition `type = 'INCIDENT'`.
+## Configuration
+* Configure PagerDuty via Config UI. See instructions
[here](/Configuration/PagerDuty.md).
+* Configure PagerDuty via Config UI's [advanced
mode](/Configuration/AdvancedMode.md).
\ No newline at end of file
