Walkthrough

 

Getting started

  1. We support Postgres 9.6 and higher, but we welcome issue reports on earlier versions too

  2. The authentication options are Google or GitHub

  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 sign in with GitHub or Google.

auth.png
 

Submit a query plan

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

If you don’t have a plan in JSON format and just want to see what pgMustard can do, select one of the examples and then Submit.

input.png
 

Work out what’s happening and what to do next

Once we have your plan, we'll display it back to you as a timing bar, a tree, and a table.

The timing bar shows the proportion of time each of the longest operations take (ordered by length).

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

With the table, we try to display the most relevant performance information not already in the reading pane.

An example plan being explored.

An example plan being explored.

 

Some options from here are:

  1. Each operation node in the timing bar and tree is linked to a table row, and clicking one will highlight the others.

  2. Click the sections in the reading pane for tips on what to do next, and links to further information where relevant.

We hope to save you time and effort understanding query plans and working out what to do next!

We also have a guide for using pgMustard with auto_explain . This allows you to log slow query plans automatically, for further analysis in pgMustard.

We regularly release improvements based on the feedback we receive so please do get in touch. The best ways are at team@pgmustard.com or via our issue tracker.

A tip with details, and a link to a blog post to learn more.

A tip with details, and a link to a blog post to learn more.