cs::apply::instruments::Applier_metrics_stub Class Reference

Class that intends to be a dummy end point for applier metrics. More...

#include <applier_metrics_stub.h>

Inheritance diagram for cs::apply::instruments::Applier_metrics_stub:

Public Member Functions
void	start_applier_timer () override
	Starts the timer when the applier metrics collection began. More...
void	stop_applier_timer () override
	Calculates the total time the applier ran. More...
int64_t	get_last_applier_start_micros () const override
	Gets the time point when the metric timer started. More...
int64_t	get_total_execution_time () const override
	Returns the total time the applier was running. More...
void	inc_transactions_committed_count (int64_t amount) override
	increment the number of transactions committed. More...
int64_t	get_transactions_committed_count () const override
	Gets the number of transactions committed. More...
void	inc_transactions_received_count (int64_t amount) override
	increment the number of transactions pending. More...
int64_t	get_transactions_received_count () const override
	Gets the number of transactions pending. More...
void	inc_transactions_committed_size_sum (int64_t amount) override
	increment the size of transactions committed. More...
int64_t	get_transactions_committed_size_sum () const override
	Gets the total sum of the size of committed transactions. More...
void	inc_transactions_received_size_sum (int64_t amount) override
	increment the pending size of queued transactions. More...
int64_t	get_transactions_received_size_sum () const override
	Gets the pending size sum of queued transactions. More...
void	inc_events_committed_count (int64_t v) override
	increment the number of events scheduled by a given amount. More...
int64_t	get_events_committed_count () const override
	Gets the number of events scheduled. More...
void	reset () override
	Resets the statistics to zero. More...
bool	is_after_metrics_breakpoint () const override
void	set_metrics_breakpoint (const char *relay_log_filename) override
	Do nothing. More...
void	check_metrics_breakpoint (const char *relay_log_filename) override
	Do nothing. More...
Time_based_metric_interface &	get_work_from_source_wait_metric () override
	Returns time metrics for waits on work from the source. More...
Time_based_metric_interface &	get_workers_available_wait_metric () override
	Returns time metrics for waits on available workers. More...
Time_based_metric_interface &	get_transaction_dependency_wait_metric () override
	Returns time metrics for waits on transaction dependecies on workers. More...
Time_based_metric_interface &	get_worker_queues_memory_exceeds_max_wait_metric () override
	Returns time metrics for waits when a worker queue exceeds max memory. More...
Time_based_metric_interface &	get_worker_queues_full_wait_metric () override
	Returns time metrics for waits when the worker queues are full. More...
Time_based_metric_interface &	get_time_to_read_from_relay_log_metric () override
	Returns time metrics for relay log read wait times. More...
void	inc_commit_order_wait_stored_metrics (int64_t count, int64_t time) override
	Increments the stored values for the commit order metrics. More...
int64_t	get_number_of_waits_on_commit_order () const override
	Gets the stored number of times we waited on committed order. More...
int64_t	get_wait_time_on_commit_order () const override
	Gets the stored summed time waited on commit order. More...
Public Member Functions inherited from cs::apply::instruments::Applier_metrics_interface
virtual	~Applier_metrics_interface ()=default

Private Attributes
Time_based_metric_stub	m_wait_for_work_from_source
	Tracks the number and time waited for transactions to apply. More...
Time_based_metric_stub	m_wait_for_worker_available
	Tracks the number and time waited for transactions to apply. More...
Time_based_metric_stub	m_wait_for_transaction_dependency
	Tracks the number and time waited for transaction dependencies. More...
Time_based_metric_stub	m_wait_due_to_worker_queues_memory_exceeds_max
	Tracks the number and time waited for transaction dependencies. More...
Time_based_metric_stub	m_wait_due_to_worker_queue_full
	Tracks the number and time waited for transaction dependencies. More...
Time_based_metric_stub	m_time_to_read_from_relay_log
	Tracks the number and time waited for transaction dependencies. More...

Detailed Description

Class that intends to be a dummy end point for applier metrics.

Member Function Documentation

check_metrics_breakpoint()

void cs::apply::instruments::Applier_metrics_stub::check_metrics_breakpoint ( const char *  relay_log_filename )

overridevirtual

Do nothing.

Implements cs::apply::instruments::Applier_metrics_interface.

get_events_committed_count()

int64_t cs::apply::instruments::Applier_metrics_stub::get_events_committed_count ( ) const

overridevirtual

Gets the number of events scheduled.

Returns

the number of events scheduled.

Implements cs::apply::instruments::Applier_metrics_interface.

get_last_applier_start_micros()

int64_t cs::apply::instruments::Applier_metrics_stub::get_last_applier_start_micros ( ) const

overridevirtual

Gets the time point when the metric timer started.

Returns

The time point since the collection of statistics started.

Implements cs::apply::instruments::Applier_metrics_interface.

get_number_of_waits_on_commit_order()

int64_t cs::apply::instruments::Applier_metrics_stub::get_number_of_waits_on_commit_order ( ) const

overridevirtual

Gets the stored number of times we waited on committed order.

Returns

the stored number of commit order waits

Implements cs::apply::instruments::Applier_metrics_interface.

get_time_to_read_from_relay_log_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_time_to_read_from_relay_log_metric ( )

overridevirtual

Returns time metrics for relay log read wait times.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

get_total_execution_time()

int64_t cs::apply::instruments::Applier_metrics_stub::get_total_execution_time ( ) const

overridevirtual

Returns the total time the applier was running.

Returns

Amount of time the applier threads were running for this channel

Implements cs::apply::instruments::Applier_metrics_interface.

get_transaction_dependency_wait_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_transaction_dependency_wait_metric ( )

overridevirtual

Returns time metrics for waits on transaction dependecies on workers.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

get_transactions_committed_count()

int64_t cs::apply::instruments::Applier_metrics_stub::get_transactions_committed_count ( ) const

overridevirtual

Gets the number of transactions committed.

Returns

the number of transactions committed.

Implements cs::apply::instruments::Applier_metrics_interface.

get_transactions_committed_size_sum()

int64_t cs::apply::instruments::Applier_metrics_stub::get_transactions_committed_size_sum ( ) const

overridevirtual

Gets the total sum of the size of committed transactions.

Returns

the total size of committed transactions

Implements cs::apply::instruments::Applier_metrics_interface.

get_transactions_received_count()

int64_t cs::apply::instruments::Applier_metrics_stub::get_transactions_received_count ( ) const

overridevirtual

Gets the number of transactions pending.

Returns

the number of transactions waiting execution.

Implements cs::apply::instruments::Applier_metrics_interface.

get_transactions_received_size_sum()

int64_t cs::apply::instruments::Applier_metrics_stub::get_transactions_received_size_sum ( ) const

overridevirtual

Gets the pending size sum of queued transactions.

Returns

the exectuted size of pending transactions

Implements cs::apply::instruments::Applier_metrics_interface.

get_wait_time_on_commit_order()

int64_t cs::apply::instruments::Applier_metrics_stub::get_wait_time_on_commit_order ( ) const

overridevirtual

Gets the stored summed time waited on commit order.

Returns

the stored sum of the time waited on commit

Implements cs::apply::instruments::Applier_metrics_interface.

get_work_from_source_wait_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_work_from_source_wait_metric ( )

overridevirtual

Returns time metrics for waits on work from the source.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

get_worker_queues_full_wait_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_worker_queues_full_wait_metric ( )

overridevirtual

Returns time metrics for waits when the worker queues are full.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

get_worker_queues_memory_exceeds_max_wait_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_worker_queues_memory_exceeds_max_wait_metric ( )

overridevirtual

Returns time metrics for waits when a worker queue exceeds max memory.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

get_workers_available_wait_metric()

Time_based_metric_interface & cs::apply::instruments::Applier_metrics_stub::get_workers_available_wait_metric ( )

overridevirtual

Returns time metrics for waits on available workers.

Returns

a Time_based_metric_interface object that contains metric information on a wait

Implements cs::apply::instruments::Applier_metrics_interface.

inc_commit_order_wait_stored_metrics()

void cs::apply::instruments::Applier_metrics_stub::inc_commit_order_wait_stored_metrics ( int64_t  count, int64_t  time  )

overridevirtual

Increments the stored values for the commit order metrics.

Parameters

count	The count for commit order waits
time	The time waited on commit order

Implements cs::apply::instruments::Applier_metrics_interface.

inc_events_committed_count()

void cs::apply::instruments::Applier_metrics_stub::inc_events_committed_count ( int64_t  v )

overridevirtual

increment the number of events scheduled by a given amount.

Parameters

v	the amount of events to increment.

Implements cs::apply::instruments::Applier_metrics_interface.

inc_transactions_committed_count()

void cs::apply::instruments::Applier_metrics_stub::inc_transactions_committed_count ( int64_t  amount )

overridevirtual

increment the number of transactions committed.

Parameters

amount

the amount of transactions to increment.

Implements cs::apply::instruments::Applier_metrics_interface.

inc_transactions_committed_size_sum()

void cs::apply::instruments::Applier_metrics_stub::inc_transactions_committed_size_sum ( int64_t  amount )

overridevirtual

increment the size of transactions committed.

Parameters

amount

the size amount to increment.

Implements cs::apply::instruments::Applier_metrics_interface.

inc_transactions_received_count()

void cs::apply::instruments::Applier_metrics_stub::inc_transactions_received_count ( int64_t  amount )

overridevirtual

increment the number of transactions pending.

Parameters

amount

the amount of transactions to increment.

Implements cs::apply::instruments::Applier_metrics_interface.

inc_transactions_received_size_sum()

void cs::apply::instruments::Applier_metrics_stub::inc_transactions_received_size_sum ( int64_t  amount )

overridevirtual

increment the pending size of queued transactions.

Parameters

amount

the size amount to increment.

Implements cs::apply::instruments::Applier_metrics_interface.

is_after_metrics_breakpoint()

bool cs::apply::instruments::Applier_metrics_stub::is_after_metrics_breakpoint ( ) const

overridevirtual

Returns

false.

Implements cs::apply::instruments::Applier_metrics_interface.

reset()

void cs::apply::instruments::Applier_metrics_stub::reset ( )

overridevirtual

Resets the statistics to zero.

Implements cs::apply::instruments::Applier_metrics_interface.

set_metrics_breakpoint()

void cs::apply::instruments::Applier_metrics_stub::set_metrics_breakpoint ( const char *  relay_log_filename )

overridevirtual

Do nothing.

Implements cs::apply::instruments::Applier_metrics_interface.

start_applier_timer()

void cs::apply::instruments::Applier_metrics_stub::start_applier_timer ( )

overridevirtual

Starts the timer when the applier metrics collection began.

Sets the state to running. This can be queried later to know for how long time the stats have been collected, i.e., the duration.

Implements cs::apply::instruments::Applier_metrics_interface.

stop_applier_timer()

void cs::apply::instruments::Applier_metrics_stub::stop_applier_timer ( )

overridevirtual

Calculates the total time the applier ran.

Sets the state to not running Sums to time since start to the total running time

Implements cs::apply::instruments::Applier_metrics_interface.

Member Data Documentation

m_time_to_read_from_relay_log

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_time_to_read_from_relay_log

private

Tracks the number and time waited for transaction dependencies.

m_wait_due_to_worker_queue_full

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_wait_due_to_worker_queue_full

private

Tracks the number and time waited for transaction dependencies.

m_wait_due_to_worker_queues_memory_exceeds_max

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_wait_due_to_worker_queues_memory_exceeds_max

private

Tracks the number and time waited for transaction dependencies.

m_wait_for_transaction_dependency

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_wait_for_transaction_dependency

private

Tracks the number and time waited for transaction dependencies.

m_wait_for_work_from_source

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_wait_for_work_from_source

private

Tracks the number and time waited for transactions to apply.

m_wait_for_worker_available

Time_based_metric_stub cs::apply::instruments::Applier_metrics_stub::m_wait_for_worker_available

private

Tracks the number and time waited for transactions to apply.

---

The documentation for this class was generated from the following files:

• sql/changestreams/apply/metrics/applier_metrics_stub.h
• sql/changestreams/apply/metrics/applier_metrics_stub.cc