The metrics administrative facet interface. More...

#include <Ice/Ice.h>

Inheritance diagram for IceMX::MetricsAdmin:

[legend]

Collaboration diagram for IceMX::MetricsAdmin:

[legend]

Public Types
typedef MetricsAdminPtr	PointerType
typedef MetricsAdminPrx	ProxyType

Public Member Functions
virtual void	disableMetricsView (const ::std::string &name, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Disable a metrics view.
virtual void	enableMetricsView (const ::std::string &name, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Enables a metrics view.
virtual MetricsFailuresSeq	getMapMetricsFailures (const ::std::string &view, const ::std::string &map, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Get the metrics failures associated with the given view and map.
virtual MetricsFailures	getMetricsFailures (const ::std::string &view, const ::std::string &map, const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Get the metrics failure associated for the given metrics.
virtual MetricsView	getMetricsView (const ::std::string &view, ::Ice::Long &timestamp, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Get the metrics objects for the given metrics view.
virtual::Ice::StringSeq	getMetricsViewNames (::Ice::StringSeq &disabledViews, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Get the names of enabled and disabled metrics.
virtual const ::std::string &	ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
virtual	~MetricsAdmin ()
Public Member Functions inherited from Ice::Object
virtual ObjectPtr	ice_clone () const
	Returns a shallow copy of the object.
virtual void	ice_collectable (bool b)
	Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool	ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
	Dispatches an invocation to a servant.
virtual SlicedDataPtr	ice_getSlicedData () const
	Obtains the sliced data associated with this instance.
virtual const std::string &	ice_id (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
	Tests whether this object supports a specific Slice interface.
virtual Int	ice_operationAttributes (const std::string &operation) const
	Returns the Freeze metadata attributes for an operation.
virtual void	ice_ping (const Current &current=Ice::emptyCurrent) const
	Tests whether this object can be reached.
virtual void	ice_postUnmarshal ()
	The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void	ice_preMarshal ()
	The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool	operator< (const Object &) const
virtual bool	operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

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

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Member Functions inherited from Ice::Object
	Object ()
virtual	~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

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

◆ PointerType

typedef MetricsAdminPtr IceMX::MetricsAdmin::PointerType

◆ ProxyType

typedef MetricsAdminPrx IceMX::MetricsAdmin::ProxyType

Constructor & Destructor Documentation

◆ ~MetricsAdmin()

virtual IceMX::MetricsAdmin::~MetricsAdmin ( )

virtual

Member Function Documentation

◆ disableMetricsView()

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

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	(	const ::std::string &	name,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

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	(	const ::std::string &	view,
		const ::std::string &	map,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

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	(	const ::std::string &	view,
		const ::std::string &	map,
		const ::std::string &	id,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

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	(	const ::std::string &	view,
		::Ice::Long &	timestamp,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

pure virtual

Get the metrics objects for the given metrics view.

This returns a dictionary 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 = ::Ice::emptyCurrent )

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 const ::std::string & IceMX::MetricsAdmin::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

virtual

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 = ::Ice::emptyCurrent ) const

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	(	const ::std::string &	id,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

virtual

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()

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/cpp98/x64/Release/Ice/Metrics.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~MetricsAdmin()

Member Function Documentation

◆ disableMetricsView()

◆ enableMetricsView()

◆ getMapMetricsFailures()

◆ getMetricsFailures()

◆ getMetricsView()

◆ getMetricsViewNames()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()