IceMX

Interface _MetricsAdminOperations

All Known Subinterfaces:

MetricsAdmin

All Known Implementing Classes:

_MetricsAdminDisp, MetricsAdminI

public interface _MetricsAdminOperations

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.

Method Summary

Modifier and Type	Method and Description
void	disableMetricsView(java.lang.String name, Current __current) Disable a metrics view.
void	enableMetricsView(java.lang.String name, Current __current) Enables a metrics view.
MetricsFailures[]	getMapMetricsFailures(java.lang.String view, java.lang.String map, Current __current) Get the metrics failures associated with the given view and map.
MetricsFailures	getMetricsFailures(java.lang.String view, java.lang.String map, java.lang.String id, Current __current) Get the metrics failure associated for the given metrics.
java.util.Map<java.lang.String,Metrics[]>	getMetricsView(java.lang.String view, LongHolder timestamp, Current __current) Get the metrics objects for the given metrics view.
java.lang.String[]	getMetricsViewNames(StringSeqHolder disabledViews, Current __current) Get the names of enabled and disabled metrics.

Method Detail

getMetricsViewNames

java.lang.String[] getMetricsViewNames(StringSeqHolder disabledViews,
                                       Current __current)

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.

enableMetricsView

void enableMetricsView(java.lang.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(java.lang.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

java.util.Map<java.lang.String,Metrics[]> getMetricsView(java.lang.String view,
                                                         LongHolder timestamp,
                                                         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.

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.

Throws:

UnknownMetricsView - Raised if the metrics view cannot be found.

getMapMetricsFailures

MetricsFailures[] getMapMetricsFailures(java.lang.String view,
                                        java.lang.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(java.lang.String view,
                                   java.lang.String map,
                                   java.lang.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.