The MetricsService API

The MetricsService interface includes the methods and classes described below.

The metrics schema is defined in metrics.wsdl, which is located in the $ENDECA_ROOT/lib/services directory on UNIX and %ENDECA_ROOT%\lib\services on Windows.

Methods

Name	Purpose	Parameters	Exception	Returns
getMetric (MetricInputType getMetricInput)	Lists the collection of metrics in an application.	getMetricInput is a MetricInputType object consisting of a path to the node you want to query and a Boolean setting that allows you to exclude that node’s children from the query.	MetricFault is the error message returned when the method fails.	getMetricOutput, a string collection of metrics.

Classes

Name	Purpose	Properties
MetricType	A class that describes a metric.	id is a unique string identifier for the metric. displayName is the name for the metric, as it appears in the output file. children is a collection of metric objects.
MetricListType	A class that describes a list of metrics.	metric is a collection of metrics comprising this MetricListType object.
MetricInputType	A class that describes the input to the getMetric method.	path is the path to the node you want to query. Null indicates top level, returning the whole tree. excludeChildren lets you indicate if you want just the metrics of the node specified in path or those of its children too.
MetricResultType	A class that describes the output returned by the getMetric method.	metric is an object of type MetricType.
AttributeType	An extension of MetricType, the AttributeType class describes an attribute metric.	value is a string describing the attribute.
MeasurementType	An extension of MetricType, the MeasurementType class describes a measurement metric.	value is a double representing the value of the measurement metric. units is a string describing the unit of measure used by the metric.