Package com.zeroc.IceMX

Interface MetricsAdmin

All Superinterfaces:

Object

public interface MetricsAdmin
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MetricsAdmin.GetMetricsViewNamesResult	Holds the result of operation getMetricsViewNames.
static class	MetricsAdmin.GetMetricsViewResult	Holds the result of operation getMetricsView.

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
void	disableMetricsView(String name, Current current)	Disable a metrics view.
void	enableMetricsView(String name, Current current)	Enables a metrics view.
MetricsFailures[]	getMapMetricsFailures(String view, String map, Current current)	Get the metrics failures associated with the given view and map.
MetricsFailures	getMetricsFailures(String view, String map, String id, Current current)	Get the metrics failure associated for the given metrics.
MetricsAdmin.GetMetricsViewResult	getMetricsView(String view, Current current)	Get the metrics objects for the given metrics view.
MetricsAdmin.GetMetricsViewNamesResult	getMetricsViewNames(Current current)	Get the names of enabled and disabled metrics.
default String	ice_id(Current current)	Returns the Slice type ID of the most-derived interface supported by this object.
default String[]	ice_ids(Current current)	Returns the Slice type IDs of the interfaces supported by this object.
static String	ice_staticId()	Returns the Slice type ID of the interface supported by this object.

Methods inherited from interface com.zeroc.Ice.Object

ice_dispatch, ice_isA, ice_ping

Method Details

getMetricsViewNames

MetricsAdmin.GetMetricsViewNamesResult getMetricsViewNames(Current current)

Get the names of enabled and disabled metrics.

Parameters:

current - The Current object for the invocation.

Returns:

An instance of MetricsAdmin.GetMetricsViewNamesResult.

enableMetricsView

void enableMetricsView(String name,
 Current current)
                throws UnknownMetricsView

Enables a metrics view.

Parameters:

name - The metrics view name.

current - The Current object for the invocation.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

disableMetricsView

void disableMetricsView(String name,
 Current current)
                 throws UnknownMetricsView

Disable a metrics view.

Parameters:

name - The metrics view name.

current - The Current object for the invocation.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMetricsView

MetricsAdmin.GetMetricsViewResult getMetricsView(String view,
 Current current)
                                          throws UnknownMetricsView

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.

current - The Current object for the invocation.

Returns:

An instance of MetricsAdmin.GetMetricsViewResult.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMapMetricsFailures

MetricsFailures[] getMapMetricsFailures(String view,
 String map,
 Current current)
                                 throws UnknownMetricsView

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.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMetricsFailures

MetricsFailures getMetricsFailures(String view,
 String map,
 String id,
 Current current)
                            throws UnknownMetricsView

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.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

ice_ids

default String[] ice_ids(Current current)

Description copied from interface: Object

Returns the Slice type IDs of the interfaces supported by this object.

Specified by:

ice_ids in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

ice_id

default String ice_id(Current current)

Description copied from interface: Object

Returns the Slice type ID of the most-derived interface supported by this object.

Specified by:

ice_id in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type ID of the most-derived interface.

ice_staticId

static String ice_staticId()

Description copied from interface: Object

Returns the Slice type ID of the interface supported by this object.

Returns:

The return value is always ::Ice::Object.