PostgreSQL Source Code  git master
Macros | Functions | Variables
auto_explain.c File Reference
#include "postgres.h"
#include <limits.h>
#include "access/parallel.h"
#include "commands/explain.h"
#include "common/pg_prng.h"
#include "executor/instrument.h"
#include "jit/jit.h"
#include "nodes/params.h"
#include "utils/guc.h"
Include dependency graph for auto_explain.c:

Go to the source code of this file.

Macros

#define auto_explain_enabled()
 

Functions

static void explain_ExecutorStart (QueryDesc *queryDesc, int eflags)
 
static void explain_ExecutorRun (QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
 
static void explain_ExecutorFinish (QueryDesc *queryDesc)
 
static void explain_ExecutorEnd (QueryDesc *queryDesc)
 
void _PG_init (void)
 

Variables

 PG_MODULE_MAGIC
 
static int auto_explain_log_min_duration = -1
 
static int auto_explain_log_parameter_max_length = -1
 
static bool auto_explain_log_analyze = false
 
static bool auto_explain_log_verbose = false
 
static bool auto_explain_log_buffers = false
 
static bool auto_explain_log_wal = false
 
static bool auto_explain_log_triggers = false
 
static bool auto_explain_log_timing = true
 
static bool auto_explain_log_settings = false
 
static int auto_explain_log_format = EXPLAIN_FORMAT_TEXT
 
static int auto_explain_log_level = LOG
 
static bool auto_explain_log_nested_statements = false
 
static double auto_explain_sample_rate = 1
 
static const struct config_enum_entry format_options []
 
static const struct config_enum_entry loglevel_options []
 
static int nesting_level = 0
 
static bool current_query_sampled = false
 
static ExecutorStart_hook_type prev_ExecutorStart = NULL
 
static ExecutorRun_hook_type prev_ExecutorRun = NULL
 
static ExecutorFinish_hook_type prev_ExecutorFinish = NULL
 
static ExecutorEnd_hook_type prev_ExecutorEnd = NULL
 

Macro Definition Documentation

◆ auto_explain_enabled

#define auto_explain_enabled ( )
Value:
(auto_explain_log_min_duration >= 0 && \
(nesting_level == 0 || auto_explain_log_nested_statements) && \
current_query_sampled)
auto_explain_log_min_duration
static int auto_explain_log_min_duration
Definition: auto_explain.c:28
auto_explain_log_nested_statements
static bool auto_explain_log_nested_statements
Definition: auto_explain.c:39
nesting_level
static int nesting_level
Definition: auto_explain.c:65
current_query_sampled
static bool current_query_sampled
Definition: auto_explain.c:68

Definition at line 70 of file auto_explain.c.

Function Documentation

◆ _PG_init()

void _PG_init ( void  )

Definition at line 93 of file auto_explain.c.

94 {
95  /* Define custom GUC variables. */
96  DefineCustomIntVariable("auto_explain.log_min_duration",
97  "Sets the minimum execution time above which plans will be logged.",
98  "Zero prints all plans. -1 turns this feature off.",
99  &auto_explain_log_min_duration,
100  -1,
101  -1, INT_MAX,
102  PGC_SUSET,
103  GUC_UNIT_MS,
104  NULL,
105  NULL,
106  NULL);
107 
108  DefineCustomIntVariable("auto_explain.log_parameter_max_length",
109  "Sets the maximum length of query parameters to log.",
110  "Zero logs no query parameters, -1 logs them in full.",
111  &auto_explain_log_parameter_max_length,
112  -1,
113  -1, INT_MAX,
114  PGC_SUSET,
115  GUC_UNIT_BYTE,
116  NULL,
117  NULL,
118  NULL);
119 
120  DefineCustomBoolVariable("auto_explain.log_analyze",
121  "Use EXPLAIN ANALYZE for plan logging.",
122  NULL,
123  &auto_explain_log_analyze,
124  false,
125  PGC_SUSET,
126  0,
127  NULL,
128  NULL,
129  NULL);
130 
131  DefineCustomBoolVariable("auto_explain.log_settings",
132  "Log modified configuration parameters affecting query planning.",
133  NULL,
134  &auto_explain_log_settings,
135  false,
136  PGC_SUSET,
137  0,
138  NULL,
139  NULL,
140  NULL);
141 
142  DefineCustomBoolVariable("auto_explain.log_verbose",
143  "Use EXPLAIN VERBOSE for plan logging.",
144  NULL,
145  &auto_explain_log_verbose,
146  false,
147  PGC_SUSET,
148  0,
149  NULL,
150  NULL,
151  NULL);
152 
153  DefineCustomBoolVariable("auto_explain.log_buffers",
154  "Log buffers usage.",
155  NULL,
156  &auto_explain_log_buffers,
157  false,
158  PGC_SUSET,
159  0,
160  NULL,
161  NULL,
162  NULL);
163 
164  DefineCustomBoolVariable("auto_explain.log_wal",
165  "Log WAL usage.",
166  NULL,
167  &auto_explain_log_wal,
168  false,
169  PGC_SUSET,
170  0,
171  NULL,
172  NULL,
173  NULL);
174 
175  DefineCustomBoolVariable("auto_explain.log_triggers",
176  "Include trigger statistics in plans.",
177  "This has no effect unless log_analyze is also set.",
178  &auto_explain_log_triggers,
179  false,
180  PGC_SUSET,
181  0,
182  NULL,
183  NULL,
184  NULL);
185 
186  DefineCustomEnumVariable("auto_explain.log_format",
187  "EXPLAIN format to be used for plan logging.",
188  NULL,
189  &auto_explain_log_format,
190  EXPLAIN_FORMAT_TEXT,
191  format_options,
192  PGC_SUSET,
193  0,
194  NULL,
195  NULL,
196  NULL);
197 
198  DefineCustomEnumVariable("auto_explain.log_level",
199  "Log level for the plan.",
200  NULL,
201  &auto_explain_log_level,
202  LOG,
203  loglevel_options,
204  PGC_SUSET,
205  0,
206  NULL,
207  NULL,
208  NULL);
209 
210  DefineCustomBoolVariable("auto_explain.log_nested_statements",
211  "Log nested statements.",
212  NULL,
213  &auto_explain_log_nested_statements,
214  false,
215  PGC_SUSET,
216  0,
217  NULL,
218  NULL,
219  NULL);
220 
221  DefineCustomBoolVariable("auto_explain.log_timing",
222  "Collect timing data, not just row counts.",
223  NULL,
224  &auto_explain_log_timing,
225  true,
226  PGC_SUSET,
227  0,
228  NULL,
229  NULL,
230  NULL);
231 
232  DefineCustomRealVariable("auto_explain.sample_rate",
233  "Fraction of queries to process.",
234  NULL,
235  &auto_explain_sample_rate,
236  1.0,
237  0.0,
238  1.0,
239  PGC_SUSET,
240  0,
241  NULL,
242  NULL,
243  NULL);
244 
245  MarkGUCPrefixReserved("auto_explain");
246 
247  /* Install hooks. */
248  prev_ExecutorStart = ExecutorStart_hook;
249  ExecutorStart_hook = explain_ExecutorStart;
250  prev_ExecutorRun = ExecutorRun_hook;
251  ExecutorRun_hook = explain_ExecutorRun;
252  prev_ExecutorFinish = ExecutorFinish_hook;
253  ExecutorFinish_hook = explain_ExecutorFinish;
254  prev_ExecutorEnd = ExecutorEnd_hook;
255  ExecutorEnd_hook = explain_ExecutorEnd;
256 }
prev_ExecutorRun
static ExecutorRun_hook_type prev_ExecutorRun
Definition: auto_explain.c:77
auto_explain_log_analyze
static bool auto_explain_log_analyze
Definition: auto_explain.c:30
explain_ExecutorEnd
static void explain_ExecutorEnd(QueryDesc *queryDesc)
Definition: auto_explain.c:368
auto_explain_log_wal
static bool auto_explain_log_wal
Definition: auto_explain.c:33
auto_explain_sample_rate
static double auto_explain_sample_rate
Definition: auto_explain.c:40
auto_explain_log_parameter_max_length
static int auto_explain_log_parameter_max_length
Definition: auto_explain.c:29
auto_explain_log_verbose
static bool auto_explain_log_verbose
Definition: auto_explain.c:31
explain_ExecutorFinish
static void explain_ExecutorFinish(QueryDesc *queryDesc)
Definition: auto_explain.c:347
explain_ExecutorStart
static void explain_ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition: auto_explain.c:262
prev_ExecutorStart
static ExecutorStart_hook_type prev_ExecutorStart
Definition: auto_explain.c:76
loglevel_options
static const struct config_enum_entry loglevel_options[]
Definition: auto_explain.c:50
auto_explain_log_timing
static bool auto_explain_log_timing
Definition: auto_explain.c:35
auto_explain_log_format
static int auto_explain_log_format
Definition: auto_explain.c:37
auto_explain_log_buffers
static bool auto_explain_log_buffers
Definition: auto_explain.c:32
auto_explain_log_triggers
static bool auto_explain_log_triggers
Definition: auto_explain.c:34
format_options
static const struct config_enum_entry format_options[]
Definition: auto_explain.c:42
prev_ExecutorEnd
static ExecutorEnd_hook_type prev_ExecutorEnd
Definition: auto_explain.c:79
auto_explain_log_level
static int auto_explain_log_level
Definition: auto_explain.c:38
explain_ExecutorRun
static void explain_ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: auto_explain.c:325
prev_ExecutorFinish
static ExecutorFinish_hook_type prev_ExecutorFinish
Definition: auto_explain.c:78
auto_explain_log_settings
static bool auto_explain_log_settings
Definition: auto_explain.c:36
LOG
#define LOG
Definition: elog.h:31
ExecutorEnd_hook
ExecutorEnd_hook_type ExecutorEnd_hook
Definition: execMain.c:68
ExecutorFinish_hook
ExecutorFinish_hook_type ExecutorFinish_hook
Definition: execMain.c:67
ExecutorStart_hook
ExecutorStart_hook_type ExecutorStart_hook
Definition: execMain.c:65
ExecutorRun_hook
ExecutorRun_hook_type ExecutorRun_hook
Definition: execMain.c:66
EXPLAIN_FORMAT_TEXT
@ EXPLAIN_FORMAT_TEXT
Definition: explain.h:29
DefineCustomRealVariable
void DefineCustomRealVariable(const char *name, const char *short_desc, const char *long_desc, double *valueAddr, double bootValue, double minValue, double maxValue, GucContext context, int flags, GucRealCheckHook check_hook, GucRealAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:5141
DefineCustomEnumVariable
void DefineCustomEnumVariable(const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, const struct config_enum_entry *options, GucContext context, int flags, GucEnumCheckHook check_hook, GucEnumAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:5196
DefineCustomBoolVariable
void DefineCustomBoolVariable(const char *name, const char *short_desc, const char *long_desc, bool *valueAddr, bool bootValue, GucContext context, int flags, GucBoolCheckHook check_hook, GucBoolAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:5085
MarkGUCPrefixReserved
void MarkGUCPrefixReserved(const char *className)
Definition: guc.c:5232
DefineCustomIntVariable
void DefineCustomIntVariable(const char *name, const char *short_desc, const char *long_desc, int *valueAddr, int bootValue, int minValue, int maxValue, GucContext context, int flags, GucIntCheckHook check_hook, GucIntAssignHook assign_hook, GucShowHook show_hook)
Definition: guc.c:5111
GUC_UNIT_MS
#define GUC_UNIT_MS
Definition: guc.h:234
PGC_SUSET
@ PGC_SUSET
Definition: guc.h:74
GUC_UNIT_BYTE
#define GUC_UNIT_BYTE
Definition: guc.h:231

References auto_explain_log_analyze, auto_explain_log_buffers, auto_explain_log_format, auto_explain_log_level, auto_explain_log_min_duration, auto_explain_log_nested_statements, auto_explain_log_parameter_max_length, auto_explain_log_settings, auto_explain_log_timing, auto_explain_log_triggers, auto_explain_log_verbose, auto_explain_log_wal, auto_explain_sample_rate, DefineCustomBoolVariable(), DefineCustomEnumVariable(), DefineCustomIntVariable(), DefineCustomRealVariable(), ExecutorEnd_hook, ExecutorFinish_hook, ExecutorRun_hook, ExecutorStart_hook, explain_ExecutorEnd(), explain_ExecutorFinish(), explain_ExecutorRun(), explain_ExecutorStart(), EXPLAIN_FORMAT_TEXT, format_options, GUC_UNIT_BYTE, GUC_UNIT_MS, LOG, loglevel_options, MarkGUCPrefixReserved(), PGC_SUSET, prev_ExecutorEnd, prev_ExecutorFinish, prev_ExecutorRun, and prev_ExecutorStart.

◆ explain_ExecutorEnd()

static void explain_ExecutorEnd ( QueryDesc *  queryDesc)
static

Definition at line 368 of file auto_explain.c.

369 {
370  if (queryDesc->totaltime && auto_explain_enabled())
371  {
372  MemoryContext oldcxt;
373  double msec;
374 
375  /*
376  * Make sure we operate in the per-query context, so any cruft will be
377  * discarded later during ExecutorEnd.
378  */
379  oldcxt = MemoryContextSwitchTo(queryDesc->estate->es_query_cxt);
380 
381  /*
382  * Make sure stats accumulation is done. (Note: it's okay if several
383  * levels of hook all do this.)
384  */
385  InstrEndLoop(queryDesc->totaltime);
386 
387  /* Log plan if duration is exceeded. */
388  msec = queryDesc->totaltime->total * 1000.0;
389  if (msec >= auto_explain_log_min_duration)
390  {
391  ExplainState *es = NewExplainState();
392 
393  es->analyze = (queryDesc->instrument_options && auto_explain_log_analyze);
394  es->verbose = auto_explain_log_verbose;
395  es->buffers = (es->analyze && auto_explain_log_buffers);
396  es->wal = (es->analyze && auto_explain_log_wal);
397  es->timing = (es->analyze && auto_explain_log_timing);
398  es->summary = es->analyze;
399  /* No support for MEMORY */
400  /* es->memory = false; */
401  es->format = auto_explain_log_format;
402  es->settings = auto_explain_log_settings;
403 
404  ExplainBeginOutput(es);
405  ExplainQueryText(es, queryDesc);
406  ExplainQueryParameters(es, queryDesc->params, auto_explain_log_parameter_max_length);
407  ExplainPrintPlan(es, queryDesc);
408  if (es->analyze && auto_explain_log_triggers)
409  ExplainPrintTriggers(es, queryDesc);
410  if (es->costs)
411  ExplainPrintJITSummary(es, queryDesc);
412  ExplainEndOutput(es);
413 
414  /* Remove last line break */
415  if (es->str->len > 0 && es->str->data[es->str->len - 1] == '\n')
416  es->str->data[--es->str->len] = '\0';
417 
418  /* Fix JSON to output an object */
419  if (auto_explain_log_format == EXPLAIN_FORMAT_JSON)
420  {
421  es->str->data[0] = '{';
422  es->str->data[es->str->len - 1] = '}';
423  }
424 
425  /*
426  * Note: we rely on the existing logging of context or
427  * debug_query_string to identify just which statement is being
428  * reported. This isn't ideal but trying to do it here would
429  * often result in duplication.
430  */
431  ereport(auto_explain_log_level,
432  (errmsg("duration: %.3f ms plan:\n%s",
433  msec, es->str->data),
434  errhidestmt(true)));
435  }
436 
437  MemoryContextSwitchTo(oldcxt);
438  }
439 
440  if (prev_ExecutorEnd)
441  prev_ExecutorEnd(queryDesc);
442  else
443  standard_ExecutorEnd(queryDesc);
444 }
auto_explain_enabled
#define auto_explain_enabled()
Definition: auto_explain.c:70
errhidestmt
int errhidestmt(bool hide_stmt)
Definition: elog.c:1413
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:1072
ereport
#define ereport(elevel,...)
Definition: elog.h:149
standard_ExecutorEnd
void standard_ExecutorEnd(QueryDesc *queryDesc)
Definition: execMain.c:476
ExplainEndOutput
void ExplainEndOutput(ExplainState *es)
Definition: explain.c:5147
ExplainPrintJITSummary
void ExplainPrintJITSummary(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:978
ExplainQueryText
void ExplainQueryText(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:1162
ExplainBeginOutput
void ExplainBeginOutput(ExplainState *es)
Definition: explain.c:5116
NewExplainState
ExplainState * NewExplainState(void)
Definition: explain.c:365
ExplainPrintPlan
void ExplainPrintPlan(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:870
ExplainQueryParameters
void ExplainQueryParameters(ExplainState *es, ParamListInfo params, int maxlen)
Definition: explain.c:1177
ExplainPrintTriggers
void ExplainPrintTriggers(ExplainState *es, QueryDesc *queryDesc)
Definition: explain.c:935
EXPLAIN_FORMAT_JSON
@ EXPLAIN_FORMAT_JSON
Definition: explain.h:31
InstrEndLoop
void InstrEndLoop(Instrumentation *instr)
Definition: instrument.c:140
MemoryContextSwitchTo
MemoryContextSwitchTo(old_ctx)
EState::es_query_cxt
MemoryContext es_query_cxt
Definition: execnodes.h:667
ExplainState::verbose
bool verbose
Definition: explain.h:48
ExplainState::settings
bool settings
Definition: explain.h:56
ExplainState::timing
bool timing
Definition: explain.h:53
ExplainState::analyze
bool analyze
Definition: explain.h:49
ExplainState::str
StringInfo str
Definition: explain.h:46
ExplainState::format
ExplainFormat format
Definition: explain.h:59
ExplainState::wal
bool wal
Definition: explain.h:52
ExplainState::summary
bool summary
Definition: explain.h:54
ExplainState::costs
bool costs
Definition: explain.h:50
ExplainState::buffers
bool buffers
Definition: explain.h:51
QueryDesc::params
ParamListInfo params
Definition: execdesc.h:42
QueryDesc::instrument_options
int instrument_options
Definition: execdesc.h:44
QueryDesc::estate
EState * estate
Definition: execdesc.h:48
QueryDesc::totaltime
struct Instrumentation * totaltime
Definition: execdesc.h:55

References ExplainState::analyze, auto_explain_enabled, auto_explain_log_analyze, auto_explain_log_buffers, auto_explain_log_format, auto_explain_log_level, auto_explain_log_min_duration, auto_explain_log_parameter_max_length, auto_explain_log_settings, auto_explain_log_timing, auto_explain_log_triggers, auto_explain_log_verbose, auto_explain_log_wal, ExplainState::buffers, ExplainState::costs, StringInfoData::data, ereport, errhidestmt(), errmsg(), EState::es_query_cxt, QueryDesc::estate, EXPLAIN_FORMAT_JSON, ExplainBeginOutput(), ExplainEndOutput(), ExplainPrintJITSummary(), ExplainPrintPlan(), ExplainPrintTriggers(), ExplainQueryParameters(), ExplainQueryText(), ExplainState::format, InstrEndLoop(), QueryDesc::instrument_options, StringInfoData::len, MemoryContextSwitchTo(), NewExplainState(), QueryDesc::params, prev_ExecutorEnd, ExplainState::settings, standard_ExecutorEnd(), ExplainState::str, ExplainState::summary, ExplainState::timing, Instrumentation::total, QueryDesc::totaltime, ExplainState::verbose, and ExplainState::wal.

Referenced by _PG_init().

◆ explain_ExecutorFinish()

static void explain_ExecutorFinish ( QueryDesc *  queryDesc)
static

Definition at line 347 of file auto_explain.c.

348 {
349  nesting_level++;
350  PG_TRY();
351  {
352  if (prev_ExecutorFinish)
353  prev_ExecutorFinish(queryDesc);
354  else
355  standard_ExecutorFinish(queryDesc);
356  }
357  PG_FINALLY();
358  {
359  nesting_level--;
360  }
361  PG_END_TRY();
362 }
PG_TRY
#define PG_TRY(...)
Definition: elog.h:370
PG_END_TRY
#define PG_END_TRY(...)
Definition: elog.h:395
PG_FINALLY
#define PG_FINALLY(...)
Definition: elog.h:387
standard_ExecutorFinish
void standard_ExecutorFinish(QueryDesc *queryDesc)
Definition: execMain.c:416

References nesting_level, PG_END_TRY, PG_FINALLY, PG_TRY, prev_ExecutorFinish, and standard_ExecutorFinish().

Referenced by _PG_init().

◆ explain_ExecutorRun()

static void explain_ExecutorRun ( QueryDesc *  queryDesc,
ScanDirection  direction,
uint64  count,
bool  execute_once 
)
static

Definition at line 325 of file auto_explain.c.

327 {
328  nesting_level++;
329  PG_TRY();
330  {
331  if (prev_ExecutorRun)
332  prev_ExecutorRun(queryDesc, direction, count, execute_once);
333  else
334  standard_ExecutorRun(queryDesc, direction, count, execute_once);
335  }
336  PG_FINALLY();
337  {
338  nesting_level--;
339  }
340  PG_END_TRY();
341 }
standard_ExecutorRun
void standard_ExecutorRun(QueryDesc *queryDesc, ScanDirection direction, uint64 count, bool execute_once)
Definition: execMain.c:308

References nesting_level, PG_END_TRY, PG_FINALLY, PG_TRY, prev_ExecutorRun, and standard_ExecutorRun().

Referenced by _PG_init().

◆ explain_ExecutorStart()

static void explain_ExecutorStart ( QueryDesc *  queryDesc,
int  eflags 
)
static

Definition at line 262 of file auto_explain.c.

263 {
264  /*
265  * At the beginning of each top-level statement, decide whether we'll
266  * sample this statement. If nested-statement explaining is enabled,
267  * either all nested statements will be explained or none will.
268  *
269  * When in a parallel worker, we should do nothing, which we can implement
270  * cheaply by pretending we decided not to sample the current statement.
271  * If EXPLAIN is active in the parent session, data will be collected and
272  * reported back to the parent, and it's no business of ours to interfere.
273  */
274  if (nesting_level == 0)
275  {
276  if (auto_explain_log_min_duration >= 0 && !IsParallelWorker())
277  current_query_sampled = (pg_prng_double(&pg_global_prng_state) < auto_explain_sample_rate);
278  else
279  current_query_sampled = false;
280  }
281 
282  if (auto_explain_enabled())
283  {
284  /* Enable per-node instrumentation iff log_analyze is required. */
285  if (auto_explain_log_analyze && (eflags & EXEC_FLAG_EXPLAIN_ONLY) == 0)
286  {
287  if (auto_explain_log_timing)
288  queryDesc->instrument_options |= INSTRUMENT_TIMER;
289  else
290  queryDesc->instrument_options |= INSTRUMENT_ROWS;
291  if (auto_explain_log_buffers)
292  queryDesc->instrument_options |= INSTRUMENT_BUFFERS;
293  if (auto_explain_log_wal)
294  queryDesc->instrument_options |= INSTRUMENT_WAL;
295  }
296  }
297 
298  if (prev_ExecutorStart)
299  prev_ExecutorStart(queryDesc, eflags);
300  else
301  standard_ExecutorStart(queryDesc, eflags);
302 
303  if (auto_explain_enabled())
304  {
305  /*
306  * Set up to track total elapsed time in ExecutorRun. Make sure the
307  * space is allocated in the per-query context so it will go away at
308  * ExecutorEnd.
309  */
310  if (queryDesc->totaltime == NULL)
311  {
312  MemoryContext oldcxt;
313 
314  oldcxt = MemoryContextSwitchTo(queryDesc->estate->es_query_cxt);
315  queryDesc->totaltime = InstrAlloc(1, INSTRUMENT_ALL, false);
316  MemoryContextSwitchTo(oldcxt);
317  }
318  }
319 }
standard_ExecutorStart
void standard_ExecutorStart(QueryDesc *queryDesc, int eflags)
Definition: execMain.c:141
EXEC_FLAG_EXPLAIN_ONLY
#define EXEC_FLAG_EXPLAIN_ONLY
Definition: executor.h:65
IsParallelWorker
#define IsParallelWorker()
Definition: parallel.h:60
InstrAlloc
Instrumentation * InstrAlloc(int n, int instrument_options, bool async_mode)
Definition: instrument.c:31
INSTRUMENT_ALL
@ INSTRUMENT_ALL
Definition: instrument.h:65
INSTRUMENT_TIMER
@ INSTRUMENT_TIMER
Definition: instrument.h:61
INSTRUMENT_BUFFERS
@ INSTRUMENT_BUFFERS
Definition: instrument.h:62
INSTRUMENT_WAL
@ INSTRUMENT_WAL
Definition: instrument.h:64
INSTRUMENT_ROWS
@ INSTRUMENT_ROWS
Definition: instrument.h:63
pg_prng_double
double pg_prng_double(pg_prng_state *state)
Definition: pg_prng.c:268
pg_global_prng_state
pg_prng_state pg_global_prng_state
Definition: pg_prng.c:34

References auto_explain_enabled, auto_explain_log_analyze, auto_explain_log_buffers, auto_explain_log_min_duration, auto_explain_log_timing, auto_explain_log_wal, auto_explain_sample_rate, current_query_sampled, EState::es_query_cxt, QueryDesc::estate, EXEC_FLAG_EXPLAIN_ONLY, InstrAlloc(), INSTRUMENT_ALL, INSTRUMENT_BUFFERS, QueryDesc::instrument_options, INSTRUMENT_ROWS, INSTRUMENT_TIMER, INSTRUMENT_WAL, IsParallelWorker, MemoryContextSwitchTo(), nesting_level, pg_global_prng_state, pg_prng_double(), prev_ExecutorStart, standard_ExecutorStart(), and QueryDesc::totaltime.

Referenced by _PG_init().

Variable Documentation

◆ auto_explain_log_analyze

bool auto_explain_log_analyze = false
static

Definition at line 30 of file auto_explain.c.

Referenced by _PG_init(), explain_ExecutorEnd(), and explain_ExecutorStart().

◆ auto_explain_log_buffers

bool auto_explain_log_buffers = false
static

Definition at line 32 of file auto_explain.c.

Referenced by _PG_init(), explain_ExecutorEnd(), and explain_ExecutorStart().

◆ auto_explain_log_format

int auto_explain_log_format = EXPLAIN_FORMAT_TEXT
static

Definition at line 37 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_level

int auto_explain_log_level = LOG
static

Definition at line 38 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_min_duration

int auto_explain_log_min_duration = -1
static

Definition at line 28 of file auto_explain.c.

Referenced by _PG_init(), explain_ExecutorEnd(), and explain_ExecutorStart().

◆ auto_explain_log_nested_statements

bool auto_explain_log_nested_statements = false
static

Definition at line 39 of file auto_explain.c.

Referenced by _PG_init().

◆ auto_explain_log_parameter_max_length

int auto_explain_log_parameter_max_length = -1
static

Definition at line 29 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_settings

bool auto_explain_log_settings = false
static

Definition at line 36 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_timing

bool auto_explain_log_timing = true
static

Definition at line 35 of file auto_explain.c.

Referenced by _PG_init(), explain_ExecutorEnd(), and explain_ExecutorStart().

◆ auto_explain_log_triggers

bool auto_explain_log_triggers = false
static

Definition at line 34 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_verbose

bool auto_explain_log_verbose = false
static

Definition at line 31 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ auto_explain_log_wal

bool auto_explain_log_wal = false
static

Definition at line 33 of file auto_explain.c.

Referenced by _PG_init(), explain_ExecutorEnd(), and explain_ExecutorStart().

◆ auto_explain_sample_rate

double auto_explain_sample_rate = 1
static

Definition at line 40 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorStart().

◆ current_query_sampled

bool current_query_sampled = false
static

Definition at line 68 of file auto_explain.c.

Referenced by explain_ExecutorStart().

◆ format_options

const struct config_enum_entry format_options[]
static
Initial value:
= {
{"text", EXPLAIN_FORMAT_TEXT, false},
{"xml", EXPLAIN_FORMAT_XML, false},
{"json", EXPLAIN_FORMAT_JSON, false},
{"yaml", EXPLAIN_FORMAT_YAML, false},
{NULL, 0, false}
}
EXPLAIN_FORMAT_XML
@ EXPLAIN_FORMAT_XML
Definition: explain.h:30
EXPLAIN_FORMAT_YAML
@ EXPLAIN_FORMAT_YAML
Definition: explain.h:32

Definition at line 40 of file auto_explain.c.

Referenced by _PG_init().

◆ loglevel_options

const struct config_enum_entry loglevel_options[]
static
Initial value:
= {
{"debug5", DEBUG5, false},
{"debug4", DEBUG4, false},
{"debug3", DEBUG3, false},
{"debug2", DEBUG2, false},
{"debug1", DEBUG1, false},
{"debug", DEBUG2, true},
{"info", INFO, false},
{"notice", NOTICE, false},
{"warning", WARNING, false},
{"log", LOG, false},
{NULL, 0, false}
}
DEBUG3
#define DEBUG3
Definition: elog.h:28
WARNING
#define WARNING
Definition: elog.h:36
DEBUG2
#define DEBUG2
Definition: elog.h:29
DEBUG1
#define DEBUG1
Definition: elog.h:30
NOTICE
#define NOTICE
Definition: elog.h:35
INFO
#define INFO
Definition: elog.h:34
DEBUG5
#define DEBUG5
Definition: elog.h:26
DEBUG4
#define DEBUG4
Definition: elog.h:27

Definition at line 40 of file auto_explain.c.

Referenced by _PG_init().

◆ nesting_level

int nesting_level = 0
static

Definition at line 65 of file auto_explain.c.

Referenced by explain_ExecutorFinish(), explain_ExecutorRun(), and explain_ExecutorStart().

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 25 of file auto_explain.c.

◆ prev_ExecutorEnd

ExecutorEnd_hook_type prev_ExecutorEnd = NULL
static

Definition at line 79 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorEnd().

◆ prev_ExecutorFinish

ExecutorFinish_hook_type prev_ExecutorFinish = NULL
static

Definition at line 78 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorFinish().

◆ prev_ExecutorRun

ExecutorRun_hook_type prev_ExecutorRun = NULL
static

Definition at line 77 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorRun().

◆ prev_ExecutorStart

ExecutorStart_hook_type prev_ExecutorStart = NULL
static

Definition at line 76 of file auto_explain.c.

Referenced by _PG_init(), and explain_ExecutorStart().