Walkthrough

 

Getting started

  1. We've so far only tested pgMustard on plans created with 10.x versions of PostgeSQL, but we welcome reports of issues on other (especially newer!) versions

  2. We use Google for authentication (with only very basic permissions), so you'll need a (free) Google account attached to the email you want to use 

  3. We currently need plans to be in the JSON format, and work best with the following flags set: EXPLAIN (ANALYZE, BUFFERS, VERBOSE, FORMAT JSON)

 

Authentication

Step one is to navigate to https://app.pgmustard.com/ and log in with your Google account.

If this doesn't work, we may have added the wrong account for you. Please get in touch with us on team@pgmustard.com.

auth.png
 

What's the plan?

Once you're in, all we need from you is your query plan.

If you don’t have a plan in the format required yet, or just want a quick way to demo, hit Example, and then Submit.

If you hit any errors at this stage, we’ll get an automatic message, but would still like to hear from you! As before, get in touch on team@pgmustard.com.

 

The fun bit

Once we have your plan, we'll display it back to you as both a tree and a table, and it'll look something like this.

With the tree, we’re hoping to somewhat mirror the indentation of the text plans you may be used to.

With the table, we’re trying to only display the most relevant information for working out what the performance issues are, and what to do next.

An example of the tree and table views for a simple plan.

Some options from here are:

  1. Hover over the nodes, tips, or table headers for more info

  2. Each node is linked to a row, and clicking one will highlight the other

We really hope to save you time and effort exploring plans, and working out what best to try next. 

Feedback is always welcome, please do get in touch.

Selecting a row / node and hovering over a tip in action.