MySQL :: MySQL 8.0 Reference Manual :: 29.4.7 Pre-Filtering by Consumer (original) (raw)

29.4.7 Pre-Filtering by Consumer

The setup_consumers table lists the available consumer types and which are enabled:

mysql> SELECT * FROM performance_schema.setup_consumers;
+----------------------------------+---------+
| NAME                             | ENABLED |
+----------------------------------+---------+
| events_stages_current            | NO      |
| events_stages_history            | NO      |
| events_stages_history_long       | NO      |
| events_statements_cpu            | NO      |
| events_statements_current        | YES     |
| events_statements_history        | YES     |
| events_statements_history_long   | NO      |
| events_transactions_current      | YES     |
| events_transactions_history      | YES     |
| events_transactions_history_long | NO      |
| events_waits_current             | NO      |
| events_waits_history             | NO      |
| events_waits_history_long        | NO      |
| global_instrumentation           | YES     |
| thread_instrumentation           | YES     |
| statements_digest                | YES     |
+----------------------------------+---------+

Modify the setup_consumers table to affect pre-filtering at the consumer stage and determine the destinations to which events are sent. To enable or disable a consumer, set its ENABLED value toYES or NO.

Modifications to thesetup_consumers table affect monitoring immediately.

If you disable a consumer, the server does not spend time maintaining destinations for that consumer. For example, if you do not care about historical event information, disable the history consumers:

UPDATE performance_schema.setup_consumers
SET ENABLED = 'NO'
WHERE NAME LIKE '%history%';

The consumer settings in thesetup_consumers table form a hierarchy from higher levels to lower. The following principles apply:

Destinations associated with a consumer receive no events unless the Performance Schema checks the consumer and the consumer is enabled.
A consumer is checked only if all consumers it depends on (if any) are enabled.
If a consumer is not checked, or is checked but is disabled, other consumers that depend on it are not checked.
Dependent consumers may have their own dependent consumers.
If an event would not be sent to any destination, the Performance Schema does not produce it.

The following lists describe the available consumer values. For discussion of several representative consumer configurations and their effect on instrumentation, seeSection 29.4.8, “Example Consumer Configurations”.

Global and Thread Consumers

global_instrumentation is the highest level consumer. Ifglobal_instrumentation isNO, it disables global instrumentation. All other settings are lower level and are not checked; it does not matter what they are set to. No global or per thread information is maintained and no individual events are collected in the current-events or event-history tables. If global_instrumentation isYES, the Performance Schema maintains information for global states and also checks thethread_instrumentation consumer.
thread_instrumentation is checked only if global_instrumentation isYES. Otherwise, ifthread_instrumentation isNO, it disables thread-specific instrumentation and all lower-level settings are ignored. No information is maintained per thread and no individual events are collected in the current-events or event-history tables. Ifthread_instrumentation isYES, the Performance Schema maintains thread-specific information and also checksevents_ _`xxx`__current consumers.

Wait Event Consumers

These consumers require bothglobal_instrumentation andthread_instrumentation to beYES or they are not checked. If checked, they act as follows:

events_waits_current, ifNO, disables collection of individual wait events in theevents_waits_current table. If YES, it enables wait event collection and the Performance Schema checks theevents_waits_history andevents_waits_history_long consumers.
events_waits_history is not checked ifevent_waits_current isNO. Otherwise, anevents_waits_history value ofNO or YES disables or enables collection of wait events in theevents_waits_history table.
events_waits_history_long is not checked if event_waits_current isNO. Otherwise, anevents_waits_history_long value ofNO or YES disables or enables collection of wait events in theevents_waits_history_long table.

Stage Event Consumers

These consumers require bothglobal_instrumentation andthread_instrumentation to beYES or they are not checked. If checked, they act as follows:

events_stages_current, ifNO, disables collection of individual stage events in theevents_stages_current table. If YES, it enables stage event collection and the Performance Schema checks theevents_stages_history andevents_stages_history_long consumers.
events_stages_history is not checked ifevent_stages_current isNO. Otherwise, anevents_stages_history value ofNO or YES disables or enables collection of stage events in theevents_stages_history table.
events_stages_history_long is not checked if event_stages_current isNO. Otherwise, anevents_stages_history_long value ofNO or YES disables or enables collection of stage events in theevents_stages_history_long table.

Statement Event Consumers

These consumers require bothglobal_instrumentation andthread_instrumentation to beYES or they are not checked. If checked, they act as follows:

events_statements_cpu, ifNO, disables measurement ofCPU_TIME. If YES, and the instrumentation is enabled and timed,CPU_TIME is measured.
events_statements_current, ifNO, disables collection of individual statement events in theevents_statements_current table. If YES, it enables statement event collection and the Performance Schema checks theevents_statements_history andevents_statements_history_long consumers.
events_statements_history is not checked if events_statements_current isNO. Otherwise, anevents_statements_history value ofNO or YES disables or enables collection of statement events in theevents_statements_history table.
events_statements_history_long is not checked if events_statements_current isNO. Otherwise, anevents_statements_history_long value ofNO or YES disables or enables collection of statement events in theevents_statements_history_long table.

Transaction Event Consumers

These consumers require bothglobal_instrumentation andthread_instrumentation to beYES or they are not checked. If checked, they act as follows:

events_transactions_current, ifNO, disables collection of individual transaction events in theevents_transactions_current table. If YES, it enables transaction event collection and the Performance Schema checks theevents_transactions_history andevents_transactions_history_long consumers.
events_transactions_history is not checked if events_transactions_current is NO. Otherwise, anevents_transactions_history value ofNO or YES disables or enables collection of transaction events in theevents_transactions_history table.
events_transactions_history_long is not checked if events_transactions_current is NO. Otherwise, anevents_transactions_history_long value of NO or YES disables or enables collection of transaction events in theevents_transactions_history_long table.

Statement Digest Consumer

The statements_digest consumer requiresglobal_instrumentation to beYES or it is not checked. There is no dependency on the statement event consumers, so you can obtain statistics per digest without having to collect statistics inevents_statements_current, which is advantageous in terms of overhead. Conversely, you can get detailed statements inevents_statements_current without digests (the DIGEST andDIGEST_TEXT columns areNULL in this case).

For more information about statement digesting, seeSection 29.10, “Performance Schema Statement Digests and Sampling”.