The metrics administrative facet interface.
More...
defined in <Ice/Metrics.ice>
["format:sliced"]
interface MetricsAdmin { ... }
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.
◆ disableMetricsView()
Disable a metrics view.
- Parameters
-
name | The metrics view name. |
- Exceptions
-
◆ enableMetricsView()
Enables a metrics view.
- Parameters
-
name | The metrics view name. |
- Exceptions
-
◆ getMapMetricsFailures()
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. |
- Returns
- The metrics failures associated with the map.
- Exceptions
-
◆ getMetricsFailures()
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. |
- Returns
- The metrics failures associated with the metrics.
- Exceptions
-
◆ getMetricsView()
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. |
- Returns
- The metrics view data.
- Exceptions
-
◆ getMetricsViewNames()
Get the names of enabled and disabled metrics.
- Parameters
-
disabledViews | The names of the disabled views. |
- Returns
- The name of the enabled views.
The documentation for this interface was generated from the following file: