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

feat(frontend): support explain with graphviz visualization in dashboard #19558

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

lyang24
Copy link
Contributor

@lyang24 lyang24 commented Nov 25, 2024

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

#19542

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

new ui for rendering graphviz output to replace explain distsql.

image

example usage:

  1. run explain (format dot, distsql) xxx and copy the dot output.
  2. paste the dot output to dashboard and click parse generate graphviz visualization.

Copy link
Contributor

@kwannoel kwannoel left a comment

Choose a reason for hiding this comment

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

We can deprecate all the code related to rendering explain JSON, and remove it from the UI as an option, along with its dependencies. explain (format dot) is the only option we need. It already provides a graph structure, so all we need to do is let a graphviz library render it. It will save us a lot of code.

@lyang24 lyang24 requested a review from kwannoel November 26, 2024 06:32
@lyang24 lyang24 force-pushed the explain_dot_ui2 branch 2 times, most recently from 5e5749c to c63b60a Compare November 26, 2024 06:39
@lyang24 lyang24 marked this pull request as ready for review November 26, 2024 06:39
@lyang24 lyang24 force-pushed the explain_dot_ui2 branch 3 times, most recently from 9bb7d56 to 967828c Compare November 26, 2024 08:06
@kwannoel kwannoel requested review from BugenZhao and xxchan November 26, 2024 09:58
@kwannoel
Copy link
Contributor

Will try to run it later.

@kwannoel
Copy link
Contributor

Screenshot 2024-11-26 at 10 06 47 PM

LGTM, we can also update the naming of this tab. It can render any graphviz output, so we can rename it as Render Graphviz Dot format.

@kwannoel
Copy link
Contributor

I think the screenshot in the release note also should be updated.

@lyang24
Copy link
Contributor Author

lyang24 commented Nov 27, 2024

Render Graphviz Dot format

updated the release note and updated title to Render Graphviz Dot format

@kwannoel kwannoel added this pull request to the merge queue Nov 28, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 28, 2024
@kwannoel kwannoel added this pull request to the merge queue Nov 28, 2024
Merged via the queue into risingwavelabs:main with commit 5bc4d0c Nov 28, 2024
29 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants