Skip to main content

PerformanceCaptureConfig

Struct PerformanceCaptureConfig 

Source
#[non_exhaustive]
pub struct PerformanceCaptureConfig {
Show 14 fields pub enabled: Option<bool>, pub probing_interval_seconds: Option<i32>, pub probe_threshold: Option<i32>, pub running_threads_threshold: Option<i32>, pub seconds_behind_source_threshold: Option<i32>, pub transaction_duration_threshold: Option<i32>, pub cpu_utilization_threshold_percent: Option<i32>, pub memory_usage_threshold_percent: Option<i32>, pub transaction_lock_wait_threshold_count: Option<i32>, pub semaphore_wait_threshold_count: Option<i32>, pub history_list_length_threshold_count: Option<i32>, pub transaction_kill_threshold_seconds: Option<i32>, pub transaction_kill_excluded_user_hosts: Vec<String>, pub transaction_kill_type: Option<TransactionKillType>, /* private fields */
}
Expand description

Performance capture configuration.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§enabled: Option<bool>

Optional. Enables or disables the performance capture feature.

§probing_interval_seconds: Option<i32>

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

§probe_threshold: Option<i32>

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

§running_threads_threshold: Option<i32>

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

§seconds_behind_source_threshold: Option<i32>

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

§transaction_duration_threshold: Option<i32>

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: Option<i32>

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: Option<i32>

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: Option<i32>

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: Option<i32>

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: Option<i32>

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: Option<i32>

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: Vec<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: Option<TransactionKillType>

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.

Implementations§

Source§

impl PerformanceCaptureConfig

Source

pub fn new() -> Self

Creates a new default instance.

Source

pub fn set_enabled<T>(self, v: T) -> Self
where T: Into<bool>,

Sets the value of enabled.

§Example
let x = PerformanceCaptureConfig::new().set_enabled(true);
Source

pub fn set_or_clear_enabled<T>(self, v: Option<T>) -> Self
where T: Into<bool>,

Sets or clears the value of enabled.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_enabled(Some(false));
let x = PerformanceCaptureConfig::new().set_or_clear_enabled(None::<bool>);
Source

pub fn set_probing_interval_seconds<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of probing_interval_seconds.

§Example
let x = PerformanceCaptureConfig::new().set_probing_interval_seconds(42);
Source

pub fn set_or_clear_probing_interval_seconds<T>(self, v: Option<T>) -> Self
where T: Into<i32>,

Sets or clears the value of probing_interval_seconds.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_probing_interval_seconds(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_probing_interval_seconds(None::<i32>);
Source

pub fn set_probe_threshold<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of probe_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_probe_threshold(42);
Source

pub fn set_or_clear_probe_threshold<T>(self, v: Option<T>) -> Self
where T: Into<i32>,

Sets or clears the value of probe_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_probe_threshold(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_probe_threshold(None::<i32>);
Source

pub fn set_running_threads_threshold<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of running_threads_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_running_threads_threshold(42);
Source

pub fn set_or_clear_running_threads_threshold<T>(self, v: Option<T>) -> Self
where T: Into<i32>,

Sets or clears the value of running_threads_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_running_threads_threshold(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_running_threads_threshold(None::<i32>);
Source

pub fn set_seconds_behind_source_threshold<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of seconds_behind_source_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_seconds_behind_source_threshold(42);
Source

pub fn set_or_clear_seconds_behind_source_threshold<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of seconds_behind_source_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_seconds_behind_source_threshold(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_seconds_behind_source_threshold(None::<i32>);
Source

pub fn set_transaction_duration_threshold<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of transaction_duration_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_transaction_duration_threshold(42);
Source

pub fn set_or_clear_transaction_duration_threshold<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of transaction_duration_threshold.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_duration_threshold(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_duration_threshold(None::<i32>);
Source

pub fn set_cpu_utilization_threshold_percent<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of cpu_utilization_threshold_percent.

§Example
let x = PerformanceCaptureConfig::new().set_cpu_utilization_threshold_percent(42);
Source

pub fn set_or_clear_cpu_utilization_threshold_percent<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of cpu_utilization_threshold_percent.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_cpu_utilization_threshold_percent(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_cpu_utilization_threshold_percent(None::<i32>);
Source

pub fn set_memory_usage_threshold_percent<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of memory_usage_threshold_percent.

§Example
let x = PerformanceCaptureConfig::new().set_memory_usage_threshold_percent(42);
Source

pub fn set_or_clear_memory_usage_threshold_percent<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of memory_usage_threshold_percent.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_memory_usage_threshold_percent(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_memory_usage_threshold_percent(None::<i32>);
Source

pub fn set_transaction_lock_wait_threshold_count<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of transaction_lock_wait_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_transaction_lock_wait_threshold_count(42);
Source

pub fn set_or_clear_transaction_lock_wait_threshold_count<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of transaction_lock_wait_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_lock_wait_threshold_count(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_lock_wait_threshold_count(None::<i32>);
Source

pub fn set_semaphore_wait_threshold_count<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of semaphore_wait_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_semaphore_wait_threshold_count(42);
Source

pub fn set_or_clear_semaphore_wait_threshold_count<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of semaphore_wait_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_semaphore_wait_threshold_count(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_semaphore_wait_threshold_count(None::<i32>);
Source

pub fn set_history_list_length_threshold_count<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of history_list_length_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_history_list_length_threshold_count(42);
Source

pub fn set_or_clear_history_list_length_threshold_count<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of history_list_length_threshold_count.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_history_list_length_threshold_count(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_history_list_length_threshold_count(None::<i32>);
Source

pub fn set_transaction_kill_threshold_seconds<T>(self, v: T) -> Self
where T: Into<i32>,

Sets the value of transaction_kill_threshold_seconds.

§Example
let x = PerformanceCaptureConfig::new().set_transaction_kill_threshold_seconds(42);
Source

pub fn set_or_clear_transaction_kill_threshold_seconds<T>( self, v: Option<T>, ) -> Self
where T: Into<i32>,

Sets or clears the value of transaction_kill_threshold_seconds.

§Example
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_kill_threshold_seconds(Some(42));
let x = PerformanceCaptureConfig::new().set_or_clear_transaction_kill_threshold_seconds(None::<i32>);
Source

pub fn set_transaction_kill_excluded_user_hosts<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of transaction_kill_excluded_user_hosts.

§Example
let x = PerformanceCaptureConfig::new().set_transaction_kill_excluded_user_hosts(["a", "b", "c"]);
Source

pub fn set_transaction_kill_type<T>(self, v: T) -> Self

Sets the value of transaction_kill_type.

§Example
use google_cloud_sql_v1::model::performance_capture_config::TransactionKillType;
let x0 = PerformanceCaptureConfig::new().set_transaction_kill_type(TransactionKillType::ReadOnlyTransactions);
let x1 = PerformanceCaptureConfig::new().set_transaction_kill_type(TransactionKillType::AllTransactions);
Source

pub fn set_or_clear_transaction_kill_type<T>(self, v: Option<T>) -> Self

Sets or clears the value of transaction_kill_type.

§Example
use google_cloud_sql_v1::model::performance_capture_config::TransactionKillType;
let x0 = PerformanceCaptureConfig::new().set_or_clear_transaction_kill_type(Some(TransactionKillType::ReadOnlyTransactions));
let x1 = PerformanceCaptureConfig::new().set_or_clear_transaction_kill_type(Some(TransactionKillType::AllTransactions));
let x_none = PerformanceCaptureConfig::new().set_or_clear_transaction_kill_type(None::<TransactionKillType>);

Trait Implementations§

Source§

impl Clone for PerformanceCaptureConfig

Source§

fn clone(&self) -> PerformanceCaptureConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PerformanceCaptureConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PerformanceCaptureConfig

Source§

fn default() -> PerformanceCaptureConfig

Returns the “default value” for a type. Read more
Source§

impl Message for PerformanceCaptureConfig

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for PerformanceCaptureConfig

Source§

fn eq(&self, other: &PerformanceCaptureConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PerformanceCaptureConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more