The metrics administrative facet interface. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::MetricsAdmin:

Collaboration diagram for IceMX::MetricsAdmin:

Classes
struct	GetMetricsViewNamesResult
	Encapsulates the results of a call to getMetricsViewNames. More...

struct	GetMetricsViewResult
	Encapsulates the results of a call to getMetricsView. More...

Public Types
using	ProxyType = MetricsAdminPrx

Public Member Functions
virtual void	disableMetricsView (::std::string name, const ::Ice::Current &current)=0
	Disable a metrics view. More...

virtual void	enableMetricsView (::std::string name, const ::Ice::Current &current)=0
	Enables a metrics view. More...

virtual MetricsFailuresSeq	getMapMetricsFailures (::std::string view, ::std::string map, const ::Ice::Current &current)=0
	Get the metrics failures associated with the given view and map. More...

virtual MetricsFailures	getMetricsFailures (::std::string view, ::std::string map, ::std::string id, const ::Ice::Current &current)=0
	Get the metrics failure associated for the given metrics. More...

virtual MetricsView	getMetricsView (::std::string view, long long int &timestamp, const ::Ice::Current &current)=0
	Get the metrics objects for the given metrics view. More...

virtual ::Ice::StringSeq	getMetricsViewNames (::Ice::StringSeq &disabledViews, const ::Ice::Current &current)=0
	Get the names of enabled and disabled metrics. More...

virtual ::std::string	ice_id (const ::Ice::Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object. More...

virtual ::std::vector<::std::string >	ice_ids (const ::Ice::Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...

virtual bool	ice_isA (::std::string id, const ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID. More...

Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant. More...

virtual std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...

virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object. More...

virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...

virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...

virtual	~Object ()=default

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class. More...

Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type. More...

Detailed Description

The metrics administrative facet interface.

This interface allows remote administrative clients to access metrics of an application that enabled the Ice administrative facility and configured some metrics views.

Member Typedef Documentation

◆ ProxyType

using IceMX::MetricsAdmin::ProxyType = MetricsAdminPrx

Member Function Documentation

◆ disableMetricsView()

virtual void IceMX::MetricsAdmin::disableMetricsView	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

Disable a metrics view.

Parameters

name	The metrics view name.
current	The Current object for the invocation.

Exceptions

IceMX::UnknownMetricsView Raised if the metrics view cannot be found.

◆ enableMetricsView()

virtual void IceMX::MetricsAdmin::enableMetricsView	(	::std::string	name,
		const ::Ice::Current &	current
	)

pure virtual

Enables a metrics view.

Parameters

name	The metrics view name.
current	The Current object for the invocation.

Exceptions

IceMX::UnknownMetricsView Raised if the metrics view cannot be found.

◆ getMapMetricsFailures()

virtual MetricsFailuresSeq IceMX::MetricsAdmin::getMapMetricsFailures	(	::std::string	view,
		::std::string	map,
		const ::Ice::Current &	current
	)

pure virtual

Get the metrics failures associated with the given view and map.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
current	The Current object for the invocation.

Returns: The metrics failures associated with the map.

Exceptions

IceMX::UnknownMetricsView Raised if the metrics view cannot be found.

◆ getMetricsFailures()

virtual MetricsFailures IceMX::MetricsAdmin::getMetricsFailures	(	::std::string	view,
		::std::string	map,
		::std::string	id,
		const ::Ice::Current &	current
	)

pure virtual

Get the metrics failure associated for the given metrics.

Parameters

view	The name of the metrics view.
map	The name of the metrics map.
id	The ID of the metrics.
current	The Current object for the invocation.

Returns: The metrics failures associated with the metrics.

Exceptions

IceMX::UnknownMetricsView Raised if the metrics view cannot be found.

◆ getMetricsView()

virtual MetricsView IceMX::MetricsAdmin::getMetricsView	(	::std::string	view,
		long long int &	timestamp,
		const ::Ice::Current &	current
	)

pure virtual

Get the metrics objects for the given metrics view.

This returns a dictionnary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.

Parameters

view	The name of the metrics view.
timestamp	The local time of the process when the metrics object were retrieved.
current	The Current object for the invocation.

Returns: The metrics view data.

Exceptions

IceMX::UnknownMetricsView Raised if the metrics view cannot be found.

◆ getMetricsViewNames()

virtual ::Ice::StringSeq IceMX::MetricsAdmin::getMetricsViewNames	(	::Ice::StringSeq &	disabledViews,
		const ::Ice::Current &	current
	)

pure virtual

Get the names of enabled and disabled metrics.

Parameters

disabledViews	The names of the disabled views.
current	The Current object for the invocation.

Returns: The name of the enabled views.

◆ ice_id()

virtual ::std::string IceMX::MetricsAdmin::ice_id ( const ::Ice::Current & current ) const

override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string> IceMX::MetricsAdmin::ice_ids ( const ::Ice::Current & current ) const

override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceMX::MetricsAdmin::ice_isA	(	::std::string	id,
		const ::Ice::Current &	current
	)		const

overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

◆ ice_staticId()

static const ::std::string& IceMX::MetricsAdmin::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

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

generated/cpp11/x64/Release/Ice/Metrics.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ disableMetricsView()

◆ enableMetricsView()

◆ getMapMetricsFailures()

◆ getMetricsFailures()

◆ getMetricsView()

◆ getMetricsViewNames()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()