Functions
void	isc::stats::StatsMgr::addValue (const std::string &name, const double value)
	Records incremental floating point observation.

void	isc::stats::StatsMgr::addValue (const std::string &name, const int64_t value)
	Records incremental integer observation.

void	isc::stats::StatsMgr::addValue (const std::string &name, const isc::util::int128_t &value)
	Records an incremental big integer observation.

void	isc::stats::StatsMgr::addValue (const std::string &name, const StatsDuration &value)
	Records incremental duration observation.

void	isc::stats::StatsMgr::addValue (const std::string &name, const std::string &value)
	Records incremental string observation.

const StatsDuration &	isc::stats::StatsMgr::getMaxSampleAgeDefault () const
	Get default duration limit.

uint32_t	isc::stats::StatsMgr::getMaxSampleCountDefault () const
	Get default count limit.

bool	isc::stats::StatsMgr::setMaxSampleAge (const std::string &name, const StatsDuration &duration)
	Determines maximum age of samples.

void	isc::stats::StatsMgr::setMaxSampleAgeAll (const StatsDuration &duration)
	Set duration limit for all collected statistics.

void	isc::stats::StatsMgr::setMaxSampleAgeDefault (const StatsDuration &duration)
	Set default duration limit.

bool	isc::stats::StatsMgr::setMaxSampleCount (const std::string &name, uint32_t max_samples)
	Determines how many samples of a given statistic should be kept.

void	isc::stats::StatsMgr::setMaxSampleCountAll (uint32_t max_samples)
	Set count limit for all collected statistics.

void	isc::stats::StatsMgr::setMaxSampleCountDefault (uint32_t max_samples)
	Set default count limit.

void	isc::stats::StatsMgr::setValue (const std::string &name, const double value)
	Records absolute floating point observation.

void	isc::stats::StatsMgr::setValue (const std::string &name, const int64_t value)
	Records absolute integer observation.

void	isc::stats::StatsMgr::setValue (const std::string &name, const isc::util::int128_t &value)
	Records an absolute big integer observation.

void	isc::stats::StatsMgr::setValue (const std::string &name, const StatsDuration &value)
	Records absolute duration observation.

void	isc::stats::StatsMgr::setValue (const std::string &name, const std::string &value)
	Records absolute string observation.

Detailed Description

The following methods are used by data producers:

Function Documentation

◆ addValue() [1/5]

void isc::stats::StatsMgr::addValue	(	const std::string &	name,
		const double	value )

Records incremental floating point observation.

Parameters

name	name of the observation
value	floating point value observed

Exceptions

InvalidStatType if statistic is not fp

Definition at line 82 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::addValueInternal().

Here is the call graph for this function:

◆ addValue() [2/5]

void isc::stats::StatsMgr::addValue	(	const std::string &	name,
		const int64_t	value )

Records incremental integer observation.

Parameters

name	name of the observation
value	integer value observed

Exceptions

InvalidStatType if statistic is not integer

Definition at line 70 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::addValueInternal().

Here is the call graph for this function:

◆ addValue() [3/5]

void isc::stats::StatsMgr::addValue	(	const std::string &	name,
		const isc::util::int128_t &	value )

Records an incremental big integer observation.

Parameters

name	name of the observation
value	integer value observed

Exceptions

InvalidStatType if statistic is not integer

Definition at line 76 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::addValueInternal().

Here is the call graph for this function:

◆ addValue() [4/5]

void isc::stats::StatsMgr::addValue	(	const std::string &	name,
		const StatsDuration &	value )

Records incremental duration observation.

Parameters

name	name of the observation
value	duration value observed

Exceptions

InvalidStatType if statistic is not time duration

Definition at line 88 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::addValueInternal().

Here is the call graph for this function:

◆ addValue() [5/5]

void isc::stats::StatsMgr::addValue	(	const std::string &	name,
		const std::string &	value )

Records incremental string observation.

Parameters

name	name of the observation
value	string value observed

Exceptions

InvalidStatType if statistic is not a string

Definition at line 94 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::addValueInternal().

Here is the call graph for this function:

◆ getMaxSampleAgeDefault()

const StatsDuration & isc::stats::StatsMgr::getMaxSampleAgeDefault ( ) const

Get default duration limit.

Returns: default maximum age of samples to keep.

Definition at line 217 of file lib/stats/stats_mgr.cc.

◆ getMaxSampleCountDefault()

uint32_t isc::stats::StatsMgr::getMaxSampleCountDefault ( ) const

Get default count limit.

Returns: default maximum number of samples to keep. (0 means that count limit was disabled)

Definition at line 228 of file lib/stats/stats_mgr.cc.

◆ setMaxSampleAge()

bool isc::stats::StatsMgr::setMaxSampleAge	(	const std::string &	name,
		const StatsDuration &	duration )

Determines maximum age of samples.

Specifies that statistic name should be stored not as a single value, but rather as a set of values. duration determines the timespan. Samples older than duration will be discarded. This is time-constrained approach. For sample count constrained approach, see setMaxSampleCount() below. Example: To set a statistic to keep observations for the last 5 minutes, call: setMaxSampleAge("incoming-packets", StatsDuration::minutes(5)); to revert statistic to a single value, call: setMaxSampleAge("incoming-packets", StatsDuration:zero());

Parameters

name	name of the observation
duration	determines maximum age of samples

Returns: true if successful, false if there's no such statistic

Definition at line 139 of file lib/stats/stats_mgr.cc.

Referenced by isc::stats::StatsMgr::statisticSetMaxSampleAgeHandler().

◆ setMaxSampleAgeAll()

void isc::stats::StatsMgr::setMaxSampleAgeAll ( const StatsDuration & duration )

Set duration limit for all collected statistics.

Parameters

duration determines maximum age of samples

Definition at line 173 of file lib/stats/stats_mgr.cc.

◆ setMaxSampleAgeDefault()

void isc::stats::StatsMgr::setMaxSampleAgeDefault ( const StatsDuration & duration )

Set default duration limit.

Parameters

duration default maximum age of samples to keep

Definition at line 195 of file lib/stats/stats_mgr.cc.

◆ setMaxSampleCount()

bool isc::stats::StatsMgr::setMaxSampleCount	(	const std::string &	name,
		uint32_t	max_samples )

Determines how many samples of a given statistic should be kept.

Specifies that statistic name should be stored not as single value, but rather as a set of values. In this form, at most max_samples will be kept. When adding max_samples + 1 sample, the oldest sample will be discarded. Example: To set a statistic to keep the last 100 observations, call: setMaxSampleCount("incoming-packets", 100);

Parameters

name	name of the observation
max_samples	how many samples of a given statistic should be kept

Returns: true if successful, false if there's no such statistic

Definition at line 156 of file lib/stats/stats_mgr.cc.

Referenced by isc::stats::StatsMgr::statisticSetMaxSampleCountHandler().

◆ setMaxSampleCountAll()

void isc::stats::StatsMgr::setMaxSampleCountAll ( uint32_t max_samples )

Set count limit for all collected statistics.

Parameters

max_samples how many samples of a given statistic should be kept

Definition at line 184 of file lib/stats/stats_mgr.cc.

◆ setMaxSampleCountDefault()

void isc::stats::StatsMgr::setMaxSampleCountDefault ( uint32_t max_samples )

Set default count limit.

Parameters

max_samples default maximum number of samples to keep (0 means to disable count limit and enable age limit)

Definition at line 206 of file lib/stats/stats_mgr.cc.

◆ setValue() [1/5]

void isc::stats::StatsMgr::setValue	(	const std::string &	name,
		const double	value )

Records absolute floating point observation.

Parameters

name	name of the observation
value	floating point value observed

Exceptions

InvalidStatType if statistic is not fp

Definition at line 52 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::setValueInternal().

Here is the call graph for this function:

◆ setValue() [2/5]

void isc::stats::StatsMgr::setValue	(	const std::string &	name,
		const int64_t	value )

Records absolute integer observation.

Parameters

name	name of the observation
value	integer value observed

Exceptions

InvalidStatType if statistic is not integer

Definition at line 40 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::setValueInternal().

Here is the call graph for this function:

◆ setValue() [3/5]

void isc::stats::StatsMgr::setValue	(	const std::string &	name,
		const isc::util::int128_t &	value )

Records an absolute big integer observation.

Parameters

name	name of the observation
value	integer value observed

Exceptions

InvalidStatType if statistic is not integer

Definition at line 46 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::setValueInternal().

Here is the call graph for this function:

◆ setValue() [4/5]

void isc::stats::StatsMgr::setValue	(	const std::string &	name,
		const StatsDuration &	value )

Records absolute duration observation.

Parameters

name	name of the observation
value	duration value observed

Exceptions

InvalidStatType if statistic is not time duration

Definition at line 58 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::setValueInternal().

Here is the call graph for this function:

◆ setValue() [5/5]

void isc::stats::StatsMgr::setValue	(	const std::string &	name,
		const std::string &	value )

Records absolute string observation.

Parameters

name	name of the observation
value	string value observed

Exceptions

InvalidStatType if statistic is not a string

Definition at line 64 of file lib/stats/stats_mgr.cc.

References isc::stats::StatsMgr::setValueInternal().

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ addValue() [1/5]

◆ addValue() [2/5]

◆ addValue() [3/5]

◆ addValue() [4/5]

◆ addValue() [5/5]

◆ getMaxSampleAgeDefault()

◆ getMaxSampleCountDefault()

◆ setMaxSampleAge()

◆ setMaxSampleAgeAll()

◆ setMaxSampleAgeDefault()

◆ setMaxSampleCount()

◆ setMaxSampleCountAll()

◆ setMaxSampleCountDefault()

◆ setValue() [1/5]

◆ setValue() [2/5]

◆ setValue() [3/5]

◆ setValue() [4/5]

◆ setValue() [5/5]