Google Cloud Sql Admin V1 Client - Class PerformanceCaptureConfig (1.10.0)

1.10.0 (latest) 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.1 1.2.6 1.1.0 1.0.0 0.19.0 0.18.0 0.17.1 0.16.1 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.12

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class PerformanceCaptureConfig.

Performance capture configuration.

Generated from protobuf message google.cloud.sql.v1.PerformanceCaptureConfig

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ enabled	bool Optional. Enables or disables the performance capture feature.
↳ probing_interval_seconds	int Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.
↳ probe_threshold	int Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.
↳ running_threads_threshold	int Optional. Specifies the minimum number of MySQL Threads_running to trigger the performance capture on the primary instance.
↳ seconds_behind_source_threshold	int Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.
↳ transaction_duration_threshold	int Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.
↳ cpu_utilization_threshold_percent	int Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.
↳ memory_usage_threshold_percent	int Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.
↳ transaction_lock_wait_threshold_count	int Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.
↳ semaphore_wait_threshold_count	int Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.
↳ history_list_length_threshold_count	int Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from 10000 to 10000000. Enter 0 to disable the check.
↳ transaction_kill_threshold_seconds	int Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from 60 to 604800 (7 days). Enter 0 to disable. If enabled (i.e., > 0), this value must be greater than or equal to transaction_duration_threshold. Configurations where 0 < transaction_kill_threshold_seconds < transaction_duration_threshold will be rejected.
↳ transaction_kill_excluded_user_hosts	string[] Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: ["app_user", "db_admin\@10.1.2.3", "report_user\@%"]
↳ transaction_kill_type	int Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

getEnabled

Optional. Enables or disables the performance capture feature.

Returns
Type	Description
bool

hasEnabled

clearEnabled

setEnabled

Optional. Enables or disables the performance capture feature.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProbingIntervalSeconds

Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.

Returns
Type	Description
int

hasProbingIntervalSeconds

clearProbingIntervalSeconds

setProbingIntervalSeconds

Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getProbeThreshold

Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.

Returns
Type	Description
int

hasProbeThreshold

clearProbeThreshold

setProbeThreshold

Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRunningThreadsThreshold

Optional. Specifies the minimum number of MySQL Threads_running to trigger the performance capture on the primary instance.

Returns
Type	Description
int

hasRunningThreadsThreshold

clearRunningThreadsThreshold

setRunningThreadsThreshold

Optional. Specifies the minimum number of MySQL Threads_running to trigger the performance capture on the primary instance.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSecondsBehindSourceThreshold

Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.

Returns
Type	Description
int

hasSecondsBehindSourceThreshold

clearSecondsBehindSourceThreshold

setSecondsBehindSourceThreshold

Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTransactionDurationThreshold

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.

Returns
Type	Description
int

hasTransactionDurationThreshold

clearTransactionDurationThreshold

setTransactionDurationThreshold

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCpuUtilizationThresholdPercent

Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

Returns
Type	Description
int

hasCpuUtilizationThresholdPercent

clearCpuUtilizationThresholdPercent

setCpuUtilizationThresholdPercent

Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from 10 to 99. Enter 0 to disable the check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMemoryUsageThresholdPercent

Optional. Specifies the minimum percentage of memory usage to trigger the performance capture.

Valid integers range from 10 to 99. Enter 0 to disable the check.

Returns
Type	Description
int

hasMemoryUsageThresholdPercent

clearMemoryUsageThresholdPercent

setMemoryUsageThresholdPercent

Optional. Specifies the minimum percentage of memory usage to trigger the performance capture.

Valid integers range from 10 to 99. Enter 0 to disable the check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTransactionLockWaitThresholdCount

Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

Returns
Type	Description
int

hasTransactionLockWaitThresholdCount

clearTransactionLockWaitThresholdCount

setTransactionLockWaitThresholdCount

Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from 10 to 10000. Enter 0 to disable the check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSemaphoreWaitThresholdCount

Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from 10 to 10000.

Enter 0 to disable the check.

Returns
Type	Description
int

hasSemaphoreWaitThresholdCount

clearSemaphoreWaitThresholdCount

setSemaphoreWaitThresholdCount

Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from 10 to 10000.

Enter 0 to disable the check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getHistoryListLengthThresholdCount

Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from 10000 to 10000000. Enter 0 to disable the check.

Returns
Type	Description
int

hasHistoryListLengthThresholdCount

clearHistoryListLengthThresholdCount

setHistoryListLengthThresholdCount

Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from 10000 to 10000000. Enter 0 to disable the check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTransactionKillThresholdSeconds

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from 60 to 604800 (7 days). Enter 0 to disable. If enabled (i.e., > 0), this value must be greater than or equal to transaction_duration_threshold. Configurations where 0 < transaction_kill_threshold_seconds < transaction_duration_threshold will be rejected.

Returns
Type	Description
int

hasTransactionKillThresholdSeconds

clearTransactionKillThresholdSeconds

setTransactionKillThresholdSeconds

Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from 60 to 604800 (7 days). Enter 0 to disable. If enabled (i.e., > 0), this value must be greater than or equal to transaction_duration_threshold. Configurations where 0 < transaction_kill_threshold_seconds < transaction_duration_threshold will be rejected.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTransactionKillExcludedUserHosts

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format.

Example: ["app_user", "db_admin\@10.1.2.3", "report_user\@%"]

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setTransactionKillExcludedUserHosts

Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format.

Example: ["app_user", "db_admin\@10.1.2.3", "report_user\@%"]

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getTransactionKillType

Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

Returns
Type	Description
int

hasTransactionKillType

clearTransactionKillType

setTransactionKillType

Optional. Determines which transactions are allowed to be terminated when they exceed transaction_kill_threshold_seconds. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to READ_ONLY_TRANSACTIONS if unspecified.

Parameter
Name	Description
var	int

Returns
Type	Description
$this