Skip to content

Commit bd30d89

Browse files
authored
Merge pull request #52 from alphauslabs/update_docs_v1
fix: change link format for images and update docs
2 parents 3aa7f51 + 1ebba43 commit bd30d89

3 files changed

Lines changed: 71 additions & 177 deletions

File tree

docs/octo/alerts-management.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ As of this writing, Octo has four types of alerts: **cost**, **anomaly detection
44

55
## Navigate to the Alerts Management Tab
66

7-
![Alert Management](https://drive.google.com/uc?export=view&id=1zVO5isuW9cVdJYIUmetStjX4_yQaqAx5)
7+
![Alert Management](https://lh3.googleusercontent.com/d/1zVO5isuW9cVdJYIUmetStjX4_yQaqAx5)
88

99
- Locate the gear or cog icon on the top right corner of the app header, just beside your profile picture. You will see a curation of tabs.
1010
- Under the the `NOTIFICATION` section, click `Alerts Management`.
@@ -14,14 +14,16 @@ As of this writing, Octo has four types of alerts: **cost**, **anomaly detection
1414

1515
Cost alerts aide in monitoring your cost groups' daily spend. You can monitor multiple cost groups and send alerts to multiple channels per alert. There are two types of threshold available: **fixed cost** and **percentage compared to previous day**. For the fixed cost, you supply the amount you want to be the limit for the cost group/s' daily spend and Octo will send an alert to the designated channel once your spend exceeds this limit. As for the percentage compared to the previous day's spend, the number you input will be used to measure if the day's spend exceeds the specific percentage of the previous day's spend.
1616

17-
![Cost](https://drive.google.com/uc?export=view&id=1PdrfMBUwAwzQ3UJLE9C6OXhz_KihQ3Cq)
17+
![Cost](https://lh3.googleusercontent.com/d/1PdrfMBUwAwzQ3UJLE9C6OXhz_KihQ3Cq
18+
)
1819

1920
- Navigate to the `COST` tab.
2021
- Click `CREATE NEW ALERT` and a popup dialogue box should appear.
2122
- Supply the alert name.
2223
- Choose one or multiple cost groups and click `NEXT`.
2324

24-
![Create Cost Alert](https://drive.google.com/uc?export=view&id=1kZdnalPzuo3s79rdN-OZP9Lngky5ekxI)
25+
![Create Cost Alert](https://lh3.googleusercontent.com/d/1kZdnalPzuo3s79rdN-OZP9Lngky5ekxI
26+
)
2527

2628
- Select if you would opt for the fixed or percentage type of alert.
2729
- Supply the fixed amount or percentage.
@@ -33,14 +35,16 @@ Cost alerts aide in monitoring your cost groups' daily spend. You can monitor mu
3335

3436
Anomaly detection alerts are used to monitor a cost group if there is an anomaly and alert you if there is a significant deviation from the usual spending based from your historical data. You can monitor single cost group and send alerts to multiple channels.
3537

36-
![Anomaly](https://drive.google.com/uc?export=view&id=136JtdAOnqaLhWkPhxESHEEW4N8Bkwnfs)
38+
![Anomaly](https://lh3.googleusercontent.com/d/136JtdAOnqaLhWkPhxESHEEW4N8Bkwnfs
39+
)
3740

3841
- Navigate to the `ANOMALY DETECTION` tab.
3942
- Click `CREATE NEW ALERT` and a popup dialogue box should appear.
4043
- Supply the alert name.
4144
- Choose one cost group and click `NEXT`.
4245

43-
![Create Anomaly ALert](https://drive.google.com/uc?export=view&id=1qJa-26r-aLhQqOPTe6D_QjnJOUO2vfDE)
46+
![Create Anomaly ALert](https://lh3.googleusercontent.com/d/1qJa-26r-aLhQqOPTe6D_QjnJOUO2vfDE
47+
)
4448

4549
- Choose the frequency of the alert (weekly,monthly).
4650
- Select which channels you would like the alerts to be sent to.
@@ -51,14 +55,15 @@ Anomaly detection alerts are used to monitor a cost group if there is an anomaly
5155
The Discount Expiration Alert feature allows you to monitor the expiration dates of your purchased discounts, such as Reserved Instances and Savings Plans in AWS.
5256
Currently, this feature supports **AWS** only. To create a new alert, follow the steps below.
5357

54-
![Discount Alert](https://drive.google.com/uc?export=view&id=176bfQnzeSdaEgJPkKnKjwh2r5fqbgxm1)
58+
![Discount Alert](https://lh3.googleusercontent.com/d/176bfQnzeSdaEgJPkKnKjwh2r5fqbgxm1)
5559

5660
- Navigate to the `DISCOUNT EXPIRATION` tab.
5761
- Click `CREATE NEW ALERT` and a popup dialog box should appear.
5862
- Supply the alert name.
5963
- Choose one cost group. This tracks the discount plans associated with this cost group. Then, click `NEXT`.
6064

61-
![Create Discount Alert](https://drive.google.com/uc?export=view&id=1rSX8dmInKuFTDLb5jf4rTupGIAD4p5pm)
65+
![Create Discount Alert](https://lh3.googleusercontent.com/d/1rSX8dmInKuFTDLb5jf4rTupGIAD4p5pm
66+
)
6267

6368
- Select frequencies. You can choose as many as needed.
6469
- Select which channels you would like the alerts to be sent to.
@@ -70,17 +75,21 @@ The Budget Alert feature allows you to receive notifications when your spending
7075

7176
**Note:** To create a budget alert, make sure you have already created a budget.
7277

73-
![Budget Alert](https://drive.google.com/uc?export=view&id=1Nd1DjslUmNQrgodp1bny3Mts26hnqotW)
78+
![Budget Alert](https://lh3.googleusercontent.com/d/1uoh_J0LGrH-OYDqcBWQ1yrw0nBpZvAmo
79+
)
7480

7581
- Navigate to the `BUDGET ALERT` tab.
7682
- Click the `View Details` of an existing budget.
7783

78-
![Create Budget Alert](https://drive.google.com/uc?export=view&id=1-DMIjzO89_XEXUVen7L3gfcbmgMfq0ug)
79-
![Create Budget Alert](https://drive.google.com/uc?export=view&id=1rXHbcfHKUgJkIQ1XsaTsJQZGTRFBVkzi)
84+
![Create Budget Alert](https://lh3.googleusercontent.com/d/13j3rHy6BOxhb5sdKkDFxEyYhY0pa3mGE
85+
)
86+
![Create Budget Alert](https://lh3.googleusercontent.com/d/1BksHzb36MKK-V0PGvXt31qiVvChqQSwB
87+
)
8088

8189
- Click `CREATE BUDGET ALERT` and a popup dialog box should appear.
8290

83-
![Create Budget Alert](https://drive.google.com/uc?export=view&id=1IM9AXLCOfGlCoApBFi_fz44U9qMQG7ON)
91+
![Create Budget Alert](https://lh3.googleusercontent.com/d/14uS1RLJYDVwp7PVZo4G_mJMCjalobmOD
92+
)
8493

8594
- Set both a cost value and a percentage of your total budget to define when the alert should be triggered. The alert will notify you once your spending reaches either the specified amount or the specified percentage of your budget.
8695
- Select which channels you would like the alerts to be sent to.
@@ -89,7 +98,8 @@ The Budget Alert feature allows you to receive notifications when your spending
8998

9099
## Editing an Alert
91100

92-
![Edit](https://drive.google.com/uc?export=view&id=1ayjfEX2NSF-p4LWCBfbKKEdzeeEcW8eq)
101+
![Edit](https://lh3.googleusercontent.com/d/1ayjfEX2NSF-p4LWCBfbKKEdzeeEcW8eq
102+
)
93103

94104
- Editing alerts are pretty similar to creating one.
95105
- Navigate to the tab of the desired alert type.
@@ -98,14 +108,16 @@ The Budget Alert feature allows you to receive notifications when your spending
98108

99109
## Deleting an Alert
100110

101-
![Delete](https://drive.google.com/uc?export=view&id=1HeENZzvSmN6nl81eS9eiNPy6hsIhMnzS)
111+
![Delete](https://lh3.googleusercontent.com/d/1HeENZzvSmN6nl81eS9eiNPy6hsIhMnzS
112+
)
102113

103114
- Navigate to the tab of the desired alert type.
104115
- Locate the specific alert you want to delete and click the trash icon on the far right side.
105116
- Confirm the deletion.
106117

107118
## Enable/Disable an Alert (Anomaly Detection and Discount Expiration Alerts)
108-
![Enable/Disable](https://drive.google.com/uc?export=view&id=1rUKUAlhb_RqZngmMAtm_ke65lIwkiMcB)
119+
![Enable/Disable](https://lh3.googleusercontent.com/d/1rUKUAlhb_RqZngmMAtm_ke65lIwkiMcB
120+
)
109121

110122
- Navigate to the actions column of the specific alert.
111123
- Click the toggle switch to enable or disable the alert.

docs/octo/channel-management.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ Receive alerts from Octo through three ways: **email**, **Slack**, and **MS Team
77
- Locate the gear or cog icon on the top right corner of the app header, just beside your profile picture. You will see a curation of tabs.
88
- Under the the `NOTIFICATION` section, click `Channel Management`.
99

10-
![Channel Management](https://drive.google.com/uc?export=view&id=14eAPZVe5ejyph0nogjP5NvhdL-B0nA1I)
10+
![Channel Management](https://lh3.googleusercontent.com/d/1Wo6ve2o_MuG7O_21Ak_cB71TkMeCH2pb
11+
)
1112

1213
## Creating a Channel
1314

1415
From here, you will see three cards which separate your channels per type. Click the `ADD CHANNEL` button and a popup dialogue box should appear.
1516

1617
### Slack
1718

18-
![Slack](https://drive.google.com/uc?export=view&id=1AC_Kfe1_qMM99uutTTSo5p7Z19Wg91ua)
19+
![Slack](https://lh3.googleusercontent.com/d/171rvk7754VvgvxJHtYQx-cbng4Q8jU9G
20+
)
1921

2022
- Input a channel name to your Slack channel and click `SAVE`.
2123
- This will take you to a new tab prompting you to select the Slack channel you want to connect to Octo.
@@ -25,31 +27,35 @@ From here, you will see three cards which separate your channels per type. Click
2527

2628
### MS Teams
2729

28-
![MS Teams](https://drive.google.com/uc?export=view&id=1eUrFVu-bl-P9ITk28t-1d9oAFR8HTWsJ)
30+
![MS Teams](https://lh3.googleusercontent.com/d/1eUrFVu-bl-P9ITk28t-1d9oAFR8HTWsJ
31+
)
2932

3033
- First, go to your MS Teams' channel and create a webhook. You can refer how to do so [here](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=newteams%2Cdotnet#create-an-incoming-webhook).
3134
- Input a channel name to your MS Teams channel and click `NEXT`.
3235
- Supply your MS Teams' channel's webhook and click `SAVE`.
3336

3437
### Email
3538

36-
![Email](https://drive.google.com/uc?export=view&id=171rvk7754VvgvxJHtYQx-cbng4Q8jU9G)
39+
![Email](https://lh3.googleusercontent.com/d/171rvk7754VvgvxJHtYQx-cbng4Q8jU9G
40+
)
3741

3842
- This is pretty straightforward. Just supply the channel name which could serve as a nickname or shorthand of your actual email.
3943
- Click `NEXT` and supply your email address.
4044
- Click `SAVE`.
4145

4246
## Editing a Channel
4347

44-
![Edit](https://drive.google.com/uc?export=view&id=1JvkKqSB9Z9aTKda6hv2v3-N4pXGDOk_Q)
48+
![Edit](https://lh3.googleusercontent.com/d/1JvkKqSB9Z9aTKda6hv2v3-N4pXGDOk_Q
49+
)
4550

4651
- Click the channel type card to expand the list of channels you have.
4752
- Simply click the pen icon and supply the edits. This process should be similar to creating a channel.
4853
- Click `SAVE`.
4954

5055
## Deleting a Channel
5156

52-
![Delete](https://drive.google.com/uc?export=view&id=1Xx_D3csLtomZWbIez2HhL-rmKYKiFlFy)
57+
![Delete](https://lh3.googleusercontent.com/d/1Xx_D3csLtomZWbIez2HhL-rmKYKiFlFy
58+
)
5359

5460
- Click the channel type card to expand the list of channels you have.
5561
- Simply click the trash icon and you're good to go.

0 commit comments

Comments
 (0)