Skip to content

Commit

Permalink
add view alerts to README
Browse files Browse the repository at this point in the history
removed krb as a maintainer
  • Loading branch information
Supreeth Basabattini committed Sep 16, 2021
1 parent 2a98113 commit 8135d56
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
1 change: 0 additions & 1 deletion OWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ approvers:
- T0MASD
maintainers:
- supreeth7
- Krishnanunni333
- MitaliBhalla
- chopraapooja
- dofinn
Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,27 @@ pdcli login --api-key <api-key>
```
Once logged in you need not login ever again unless there is a change in the API key.

## View Alerts

To view the alerts triggered by PagerDuty, use the command:

```
pdcli alerts
```
This will list all the high alerts assigned to **self** by default.

You can modify the alerts returned with the `assigned-to` option, you can either choose to list alerts which are assigned to *self, team* or *silentTest*.

When you use the option `assigned-to=team`, it will fetch all the alerts assigned to **Platform-SRE** team.

### Options
```
--assigned-to Filter alerts based on user or team (default "self")
--columns string Specify which columns to display separated by commas without any space in between (default "incident.id,name,cluster.id,status,severity")
--high View all high alerts (default true)
--low View all low alerts
```

## Running Tests
The test suite uses the [Ginkgo](https://onsi.github.io/ginkgo/) to run comprehensive tests using Behavior-Driven Development.

Expand All @@ -67,7 +88,6 @@ This command runs all the tests present within the 'tests' folder by default.

## Maintainers
- Dominic Finn ([email protected])
- Krishnanunni B ([email protected])
- Mitali Bhalla ([email protected])
- Pooja Rani ([email protected])
- Supreeth Basabattini ([email protected])
Expand Down

0 comments on commit 8135d56

Please sign in to comment.