Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Dashboard Sanitization script is improperly changing certain patterns #469

Closed
thezackm opened this issue Feb 28, 2022 · 2 comments
Closed
Labels
bug Something isn't working

Comments

@thezackm
Copy link
Member

thezackm commented Feb 28, 2022

Description

Using the dashboard validation script during local development (npm --prefix validator run sanitize-dashboards) is creating broken widgets on a specific query pattern seen in both the existing kentik_default dashboard and the new dashboard being added in PR #468

Steps to Reproduce

Clone the repo locally and run the dashboard validation script. No changes should be necessary as the current dashboard for Kentik Default entities is in "violation" and should show the problem.

Expected Behavior

This pattern should be ignored by the validation script since it's a valid dashboard definition and NRQL syntax before being adjusted.

Relevant Logs / Console output

This is only happening on the following pattern:

"FROM Metric SELECT round(latest(kentik.snmp.hrStorageUsed)*100/latest(kentik.snmp.hrStorageSize), .01) AS 'Used %', round(latest(kentik.snmp.hrStorageSize)*1e-6,.01) AS 'Total (MB)', round(latest(kentik.snmp.hrStorageUsed)*1e-6,.01) AS 'Used (MB)' WHERE provider = 'kentik-poweriq' FACET storage_description LIMIT MAX"

Specifically; this portion of the string:

(kentik.snmp.hrStorageSize), .01)

Which is being improperly sanitized to this: (replacing ) with } and removing ,)

(kentik.snmp.hrStorageSize} .01)

Additional context

This is negatively impacting each time a PR is run and the sanitization script is executed locally as it puts these dashboards at risk of a breaking change in production with a bad NRQL syntax on these widgets.

Image 2022-02-28 at 2 04 11 PM

Image 2022-02-28 at 2 05 50 PM

@thezackm thezackm added the bug Something isn't working label Feb 28, 2022
@naxhh
Copy link
Contributor

naxhh commented Mar 11, 2022

We created an internal task to track this ticket EIS-634

@naxhh naxhh added the tracking label Mar 11, 2022
@andre-nr
Copy link
Contributor

andre-nr commented May 4, 2022

Hi @thezackm,
a fix for this issue has been deployed.

@andre-nr andre-nr closed this as completed May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants