- Created by Faith Eng, last modified 18 minutes ago
Target Release | 2024 Q2 |
---|---|
Epic | SPCSP-58810 - [Data Platform] Monitoring & Alerting in SSAD Waiting |
Status | DRAFT |
BRD | |
Design Link | |
PM | BPM: Phoebe Heng DPM: Faith Eng |
PD | |
Developers | FE: BE: |
QA | TBD |
UAT Test Case | TBD |
Version History
Version | Description | Created By | Updated Date |
---|---|---|---|
Version | Description | Created By | Updated Date |
v1.0 | Monitoring and Alerting in SSAD – Phase 1 initial draft | 2024-02-15 |
Background
Self-Service Analysis Dashboard (SSAD) currently has a function known as "Action Box" which displays a box, listing recommended actions on a chart for the dashboard visitors to consider when identifying specific trends on the chart. However, as this feature was pushed from a top-down approach, there were several pain points faced by the user:
自助分析仪表板 (SSAD) 目前具有称为“操作框”的功能,该功能会显示一个框,在图表上列出建议的操作,供仪表板访问者在识别图表上的特定趋势时考虑。然而,由于该功能是自上而下推送的,因此用户面临着几个痛点:
- Business team only provided five actions for locals to configure, but these options are outdated and irrelevant for some of RTFM's team use cases.
业务团队只提供了五个操作供当地人配置,但这些选项已经过时,并且与 RTFM 的一些团队用例无关。 - Lengthy 2-step process to reveal the action details, which may not be very intuitive for users.
- Many users may not be aware of this function as it is tucked away at the bottom of 'Customize Tab', leading to low adoption.
Objectives
In early Q2 2024, Alert in SSAD aims to achieve the following:
- Streamline monitoring, alerting and action handling process by linking conditional formatting and target line into 1 same function
- Introduce new list of actions using the playbook as a guideline for locals to handle spikes
- Support an alert function in SSAD to minimise the time between detection and response
- Increase the visibility of action handling and alert configuration
Target Users
High Level User Flow from BPM
Role | Responsibility |
---|---|
Role | Responsibility |
RTFM |
|
Other SSAD Users |
|
To-Be Process
Navigation
Module | Description | UI Reference |
---|---|---|
Module | Description | UI Reference |
SSAD | Edit a dashboard > Monitoring Tab |
Function List
Module | Function Code | Function Name | Description |
---|---|---|---|
Module | Function Code | Function Name | Description |
SSAD | F001 | Monitoring Conditions | Set up the targeted metric in a chart and its monitoring rules to set up Conditional Formatting or Target Line |
F002 | Alert Setting |
| |
F003 | View / Edit Configuration |
| |
F004 | Tutorial | Introduce the new monitoring and alerting function via a three-step pop-up window | |
User Tracking Data | F005 | Tracking Data and Metrics | TMS for tracking data. Describe tracking requests to evaluate adoption rate of this feature |
Function Description
F01 – Monitoring Conditions
Monitoring Conditions consists of the following components:
- F010 – Overview
- F011 – Monitoring Tab
- F012 – Metric Monitoring
- F013 – Existing Configurations
Component | Description | UI Reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
F010 – Overview | [AS-IS] Each of the different chart types in SSAD supports either target line or conditional formatting function.
[TO-BE]
| Fig 1a: AS-IS target line configuration Fig 1b: AS-IS conditional formatting configuration Fig 1c: AS-IS dynamic target line | ||||||||||||||||||||||||||||||||||||||||||||||||||||
F011 – Monitoring Tab |
| Fig 2: To begin, user has to click onto "+ Add Monitoring" button from the monitoring tab | ||||||||||||||||||||||||||||||||||||||||||||||||||||
F011 – Metric Monitoring | Support user to set up Conditional Formatting or Target Line by defining the 1) Target Metric and 2) metric thresholds.
| Fig 3a: Components of Monitoring Thresholds (Conditional Formatting) Fig 3b: Components of Monitoring Thresholds (Target Line) Fig 4: A maximum of 5 metric thresholds are allowed, each severity colour can only be used once Fig 5: 5 severity colours available Fig 6: Notice displayed when an overlap of threshold range is detected Fig 7a: Target line when threshold is not met (= 500) Fig 7b: Target line with shaded area to show range of values (between 100 and 390) Fig 7c: Target line for threshold range - >= 590, < 590 Fig 7d: Target line for threshold range - > 590, between 100 and 590 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
F012 – Existing Configurations | For a seamless transition, replicate the configurations in the new function for those dashboards that have set up target line or conditional formatting.
| Fig 8a: AS-IS Single Colour and its 3 different colours Fig 8b: AS-IS Colour gradient and its 3 different colours |
F02 – Alert Settings
Alert Setting consists of the following components:
- F021 – Check Frequency
- F022 – Alert Frequency
- F023 – Alert Notification (Seatalk)
- F024 – Alert Notification (SSAD Alert Box Set-up)
- F025 – Alert Notification (SSAD Alert Box Display)
- F026 – Chart's Alert Label
Component | Description | UI Reference | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
F02 – Alert Settings |
3. [IMPORTANT] Alert scope is based on dashboard owner's data permission level (All Company / My Company)
| Fig 1a: Alert setting toggle OFF Fig 1b: Alert setting fields when turned ON | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F021 – Range to be Alerted (Check Frequency) |
| Fig 2: Defining which threshold ranges to send alerts for and its check frequency | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F022 – Alert Frequency |
| Fig 3a: 2 different options for defining alert frequency Fig 3b: Tooltip to describe the alert frequency options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F023 – Alert Notification (Seatalk) |
2 Alert(s) triggered Dashboard: Seller Chat | L2 Team Cases v2 #1 AHT met CRITICAL range of >= 5s Recommended Action(s):
#2 AHT met HIGH range of >= 10s View dashboard now:
| Fig 4: Dropdown to select seatalk group Fig 5: Corresponding emojis to severity levels Fig 6: Sample message sent on Seatalk | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F024 – Alert Notification (SSAD Alert Box Set-up ) | [AS-IS] In SSAD, user can display an action box in the chart itself, it contains an action description and up to 5 suggested actions in the form of hyperlinks. [TO-BE] Alert box shall give user information about what and how to note of any unusual behaviour from the target metric. Displayed on the top of the dashboard, it includes a description, the severity of the issue, and can include suggestions for how to resolve the situation.
F021.1 Action ListThere are a total of 28 new actions, change the url domain to the respective region's:
| Fig 7: Remove Action box Fig 8a: Suggest Actions in Alert, only the select ranges will require action configuration Fig 8b: Adding actions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F025 – Alert Notification (SSAD Alert Box Display) | By default, alert box will be pinned at the top of the dashboard when conditions are set up.
| Fig 9a: Alert box on SSAD Fig 9b: Dismiss options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F026 – Chart's Alert Label |
| FIg 10a: All alert rules displayed when hover over grey icon beside chart title FIg 10b: Only the triggered alert rules is displayed when hover over coloured icon beside chart title |
F03 – View / Edit Configuration
View / Edit Configuration consists of the following components:
- F031 – View & Edit Configuration
- F032 – Hide & Display
- F033 – Copying Dashboards and Charts
Component | Description | UI Reference |
---|---|---|
Component | Description | UI Reference |
F031 – View & Edit Configuration |
| |
F032 – Hide & Display |
| |
F033 – Copying Dashboards and Charts | Copying Charts with Monitoring and Alerts Copied chart will carry over the configurations in monitoring and alerting Copying Dashboards with Charts with Monitoring and Alerts The charts in the copied dashboard will contain the same configurations in monitoring and alerting but data permission is now based on user who copied the dashboard. (New dashboard owner) |
F04 – Tutorial
Description | UI Reference |
---|---|
Description | UI Reference |
F04.1 – Introducing Monitoring and Alerts Description: We have launched a new feature to monitor metric thresholds and send alerts to your Seatalk and dashboard! | |
F04.2 – Configure Metrics to Monitor Description: Configure up to 5 threshold ranges based on your monitoring criteria. Conditional formatting and target lines setup have been migrated here to seamlessly align with alerting. | |
F04.3 – Send Alerts on Dashboard and Seatalk Description: Get notified on both your Dashboard and preferred Seatalk group whenever metric thresholds are reached. Customise your alerts and suggest actions for your viewers to take. With SSAD Alerts, you're always in control of when and how you stay informed! | |
F04.4 – Alert Box on Dashboard Description: Once an alert is triggered, you'll be notified on the dashboard via an alert box which contains the chart name, metric thresholds and suggested actions if any. The same content will be available in the Seatalk alert if set up. When an alert is triggered, you'll get notified on the dashboard with an alert box displaying the metric thresholds, chart name and any suggested actions. Set up Seatalk alerts for the same updates! |
- No labels
- Edit Labels