|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMetricsListService
This web service provides methods to list agents, metrics paths and metrics available in Introscope Enterprise Manager.
Metrics in Introscope are specified as a combination of Agent Name (the unique name of the agent that is reporting that metric) and a Metric Name.
Agent Names always consist of 3 parts separated by '|' character - host name, process name, and agent name. For example - "MachineFoo|Weblogic|WeblogicAgent".
Metric Names are hierarchical and are separated by '|' character as well. The last part of the Metric Name is seprated by ':' character. For example - "EJB|Session|TradingBean:Average Response Time (ms)".
A metric path is a non-leaf node in the metric hierarchy tree. For example, consider the following metric tree segment
EJB Session TradingBean Average Response Time (ms) Responses Per Interval AccountBean Average Response Time (ms) Responses Per Interval
The metric paths in this segment would be "", "EJB", "EJB|Session", "EJB|Session|TradingBean" and "EJB|Session|AccountBean".
Method Summary | |
---|---|
java.lang.String[] |
listAgents(java.lang.String agentRegex)
Lists names of all agents matching a specified regular expression. |
DMetricPath[] |
listMetricPaths(java.lang.String agentRegex,
java.lang.String metricPrefix,
boolean recursive)
Lists all metric paths that are subnodes of a specified metric path prefix, for all matching agents. |
DMetric[] |
listMetrics(java.lang.String agentRegex,
java.lang.String metricRegex)
Lists all metrics that match a regular expression. |
DMetric[] |
listMetricsForMetricPath(java.lang.String agentRegex,
java.lang.String metricPath)
Lists all metrics for a metric path. |
Method Detail |
---|
java.lang.String[] listAgents(java.lang.String agentRegex) throws java.rmi.RemoteException, IntroscopeWebServicesException
agentRegex
- The agent regular expression.
java.rmi.RemoteException
IntroscopeWebServicesException
DMetricPath[] listMetricPaths(java.lang.String agentRegex, java.lang.String metricPrefix, boolean recursive) throws java.rmi.RemoteException, IntroscopeWebServicesException
EJB Session TradingBean Average Response Time (ms) Responses Per Interval AccountBean Average Response Time (ms) Responses Per Interval
If you query with metric prefic "EJB", the metric path "EJB|Session" will be returned. If you choose the recursive option, metric paths "EJB|Session", "EJB|Session|TradingBean" and "EJB|Session|AccountBean" will be returned.
Note: You have to be careful when using the recursive option. It can cause significant slowdown on the Enterprise Manager and can cause OutOfMemory errors both on the EM and your web services client code.
agentRegex
- The agent regular expression. You can also specify the exact
name of a single agent here.metricPrefix
- The specified metric path prefixrecursive
- Recursive option
java.rmi.RemoteException
IntroscopeWebServicesException
DMetric[] listMetricsForMetricPath(java.lang.String agentRegex, java.lang.String metricPath) throws java.rmi.RemoteException, IntroscopeWebServicesException
EJB Session TradingBean Average Response Time (ms) Responses Per Interval AccountBean Average Response Time (ms) Responses Per Interval
If you query for metric prefix "EJB|Session|TradingBean", metrics "EJB|Session|TradingBean:Average Response Time (ms)" and "EJB|Session|TradingBean:Responses Per Interval" will be returned. If you query for metric prefix "EJB", no metrics will be returned.
agentRegex
- The agent regular expression. You can also specify the exact
name of a single agent here.metricPath
- The specified metric path
java.rmi.RemoteException
IntroscopeWebServicesException
DMetric[] listMetrics(java.lang.String agentRegex, java.lang.String metricRegex) throws java.rmi.RemoteException, IntroscopeWebServicesException
Note: You have to be careful when specifying a very generic regular expression. It can cause significant slowdown on the Enterprise Manager and can cause OutOfMemory errors both on the EM and your web services client code.
agentRegex
- The agent regular expression.metricRegex
- The metric regular expression.
java.rmi.RemoteException
IntroscopeWebServicesException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |