Update CreateDashboard Script #26
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have added the feature of being able to run `vigilo` in a Kubernetes cluster which means the host tag sent to DataDog will be 'docker-container'. Therefore, let's use an environment variable to configure the host query parameter.
We will be adding a Query Value widget to the dashboard so we will need to add alerts to said widget. Let's differentiate between the Timeseries and Query Value alerts and add the new Query Value alerts
Similar to the timeseries request function, we will create a new function to handle the creation of requests for the query value widget. One thing to note, unlike the timeseries widget, the query value widget implements the alerts through the requests definition.
We've updated the lighthouse metrics to send both a 'score' and 'value' datapoint for each audit. As such we need to update the queries to specify the new subpath. For most of the audits, the 'value' datapoint is more useful than the 'score' datapoint. The only audits that we would use the 'score' datapoint are those with null 'value' datapoints like the 'is_crawlable' audit.
Similar to the Timeseries widget function, this adds a new function to create a Query Value widget.
We will need to pair up the query value widget and timeseries widget together in the same row. On top of that, we don't want the widgets to expand the full width. Therefore, we will pass a parameter to modify the size and position of the widgets.
This modifies the createWidgetForAllPageTypes function to create a query value widget at the same time as the timeseries widget. On top of that, we will keep track of the position of the widgets to layout them out properly per group.
This adds a custom link to the timeseries widgets such that we can link the actual webpage for the datapoint being displayed. This will make it convenient to debug and investigate the data without having to manually type out the URL.
|
QA 🎬
|
For some of the audits, we weren't scaling the comparator value to the correct unit types of the metrics being sent. Most of the metrics are in milliseconds, so we need to scale the comparator value to milliseconds as well as these values assumed the metric was in seconds.
The alert display type is CamelCase, not snake_case. This caused the warning marker to not have the correct display type.
|
QA 💎 - Running deploy_block 🦖 - I am not seeing the "Visit Webpage" link on the datapoints in a Timeseries widget: 
|
|
un_deploy_block ⚡ The other graphs within the groups do have the
|
|
un_deploy_block 🦕 |
mlahargou
approved these changes
Feb 21, 2024
| "display_type": "warning dashed" | ||
| } | ||
| ] : [] | ||
| } | ||
|
|
||
| function fetchQueryValueAlertMarkersForAudit(auditName: string) { | ||
| return ALERT_MARKERS_QUERY_VALUE.hasOwnProperty(auditName) ? ALERT_MARKERS_QUERY_VALUE[auditName] : [] |
There was a problem hiding this comment.
I see us using hasOwnProperty in a few places. Can't we simplify this?
return ALERT_MARKERS_QUERY_VALUE[auditName] ?? []
There was a problem hiding this comment.
TBH, this whole script could be improved and simplified. I thought about refactoring it by using a Factory design pattern but that is quite the over haul for the scope of the issue.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There have been quite a few changes to the underlying core logic. This has affected the metrics being sent to DataDog which in turn means the dashboards created through the
createDashboardscript are now outdated and ineffective.The
createDashboardscript has been revised in this update to enhance the efficiency and functionality of the dashboards it generates.CR
This mainly adds a new
Query Valuewidget to the dashboard building logic. The newQuery Valuewidget provides an average for all URLs of each page type, facilitating quick issue identification and correlation with data points. In contrast, theTimeserieswidget is more useful at tracking changes over time for each URL. Additionally, theTimeserieswidget has been enhanced to easily incorporatecustomLinks, allowing for direct access to relevant pages associated with the data points.QA
pnpm create-dashboardnow creates a dashboard that shows the data properlyTimeserieswidget the datapoints have aVisit Webpagelink that will take you to the actual webpage that was audited.Closes: https://github.com/iFixit/ifixit/issues/51901