Docs: Allow users to view query plans in the Web UI

[jseldess]

Background: https://airtable.com/tblD3oZPLJgGhCmch/viwINAgXA5on9pr2T/recijX3LQyP2EvCF8
PM: @piyush-singh
Eng partners: @couchand, @vilterp

PRs:

[jseldess]

This has been moved to 2.2.

[Amruta-Ranade]

From @celiala 's email:

Logical Plans: Cluster Settings

sql.metrics.statement_details.plan_collection.enabled

• Boolean, default is true
• Specifies whether to periodically save a logical plan for each fingerprint

sql.metrics.statement_details.plan_collection.period

• Duration, default is 5 minutes
• The time until a new logical plan is collected (e.g. how often we sample a new logical plan for a particular fingerprint)

[Amruta-Ranade]

The logical plan is the recent sample but the latency is an average of all SQL statements forming the fingerprint.

[Amruta-Ranade]

Reference reads:
https://www.depesz.com/2013/04/16/explaining-the-unexplainable/
https://docs.oracle.com/cd/B19306_01/server.102/b14211/ex_plan.htm#i3305

[jseldess]

@Amruta-Ranade, can you give a quick update on this project? I know it's at least partially done.

[Amruta-Ranade]

Yes, the UI docs are up-to-date with the current implementation. Since I worked on this issue for an alpha release, I wanted to keep the issue open for tracking purposes (in case we tweak the implementation before the final release).

[Amruta-Ranade]

Closing this issue since I am not anticipating any doc changes for logical plans for 19.1. Will open a follow-up issue if something comes up.

[celiala]

Hi @Amruta-Ranade -

Fyi, the functionality will be the same, but based on customer feedback we're doing one more cosmetic change -- see design prototype below:

cc @piyush-singh

[Amruta-Ranade]

Yes, but I checked the Statements page doc and do not think there's a doc impact.

[celiala]

Ah, agreed that there's no doc impact for the cosmetic change :)