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

Add Wildcard widget #25671

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Add Wildcard widget #25671

merged 4 commits into from
Oct 18, 2024

Conversation

estherk15
Copy link
Contributor

@estherk15 estherk15 commented Oct 9, 2024

What does this PR do? What is the motivation?

Merge instructions

Do not merge Pending GA

@estherk15 estherk15 requested a review from a team as a code owner October 9, 2024 20:00
@github-actions github-actions bot added the Images Images are added/removed with this PR label Oct 9, 2024
@estherk15 estherk15 added the editorial review Waiting on a more in-depth review label Oct 9, 2024
Copy link
Contributor

github-actions bot commented Oct 9, 2024

@estherk15 estherk15 force-pushed the esther/docs-8975-wildcard-widget branch from ac2b405 to 2b6ecb0 Compare October 11, 2024 18:56
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I left you a few suggestions

content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved
content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved
content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved
content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved
content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved

{{< img src="/dashboards/widgets/wildcard/example_configuration_query.png" alt="Example widget configuration metric query for system.cpu.user grouped by env" style="width:100%;" >}}

Notice the matching **query1** and **env** fields listed in the Vega-Lite specification and the Data Preview column.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't immediately clear to me what this JSON represents - and the highlighted values are env and example, so I wasn't sure where query1 came in. I think you could probably add a little more signposting around these examples to explain what you're showing the user. Is the point that the visualization starts out broken and then you fix it by reassigning the alias? If this is the case, it's useful to let the user know you're going to show them a broken example before the example appears.

Sidenote: I like the use of tables here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy paste error 😞 This should be query1. I agree this could be broken down more. I added a new section specifically to map values between Datadog and Vega-Lite, hopefully that makes it clearer!

content/en/dashboards/widgets/wildcard.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! :shipit:

@estherk15
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Oct 18, 2024

🚂 MergeQueue: pull request added to the queue

The median merge time in master is 26m.

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit 0f4a87c into master Oct 18, 2024
22 of 24 checks passed
@dd-mergequeue dd-mergequeue bot deleted the esther/docs-8975-wildcard-widget branch October 18, 2024 17:44
theraffoul pushed a commit that referenced this pull request Nov 25, 2024
* Add Wildcard widget info

* Fixes from code review

* Apply suggestions from code review

Co-authored-by: Heston Hoffman <[email protected]>

* Add more context to map values

---------

Co-authored-by: Heston Hoffman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review Images Images are added/removed with this PR mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants