Ice 3.7 Slice API Reference
Operations | List of all members
IceMX::MetricsAdmin Interface Reference

The metrics administrative facet interface. More...

defined in <Ice/Metrics.ice>

["format:sliced"]
interface MetricsAdmin { ... }

Operations

void disableMetricsView (string name) throws UnknownMetricsView
 Disable a metrics view. More...
 
void enableMetricsView (string name) throws UnknownMetricsView
 Enables a metrics view. More...
 
MetricsFailuresSeq getMapMetricsFailures (string view, string map) throws UnknownMetricsView
 Get the metrics failures associated with the given view and map. More...
 
MetricsFailures getMetricsFailures (string view, string map, string id) throws UnknownMetricsView
 Get the metrics failure associated for the given metrics. More...
 
MetricsView getMetricsView (string view, out long timestamp) throws UnknownMetricsView
 Get the metrics objects for the given metrics view. More...
 
Ice::StringSeq getMetricsViewNames (out Ice::StringSeq disabledViews)
 Get the names of enabled and disabled metrics. 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.

Operation Documentation

◆ disableMetricsView()

void disableMetricsView ( string  name) throws UnknownMetricsView

Disable a metrics view.

Parameters
nameThe metrics view name.
Exceptions
UnknownMetricsViewRaised if the metrics view cannot be found.

◆ enableMetricsView()

void enableMetricsView ( string  name) throws UnknownMetricsView

Enables a metrics view.

Parameters
nameThe metrics view name.
Exceptions
UnknownMetricsViewRaised if the metrics view cannot be found.

◆ getMapMetricsFailures()

MetricsFailuresSeq getMapMetricsFailures ( string  view,
string  map 
) throws UnknownMetricsView

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

Parameters
viewThe name of the metrics view.
mapThe name of the metrics map.
Returns
The metrics failures associated with the map.
Exceptions
UnknownMetricsViewRaised if the metrics view cannot be found.

◆ getMetricsFailures()

MetricsFailures getMetricsFailures ( string  view,
string  map,
string  id 
) throws UnknownMetricsView

Get the metrics failure associated for the given metrics.

Parameters
viewThe name of the metrics view.
mapThe name of the metrics map.
idThe ID of the metrics.
Returns
The metrics failures associated with the metrics.
Exceptions
UnknownMetricsViewRaised if the metrics view cannot be found.

◆ getMetricsView()

MetricsView getMetricsView ( string  view,
out long  timestamp 
) 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
viewThe name of the metrics view.
timestampThe local time of the process when the metrics object were retrieved.
Returns
The metrics view data.
Exceptions
UnknownMetricsViewRaised if the metrics view cannot be found.

◆ getMetricsViewNames()

Ice::StringSeq getMetricsViewNames ( out Ice::StringSeq  disabledViews)

Get the names of enabled and disabled metrics.

Parameters
disabledViewsThe names of the disabled views.
Returns
The name of the enabled views.

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