Mount Point: /api/v12/clusters/{clusterName}/services/{serviceName}/metrics


This operation has been deprecated. This endpoint is not supported as of v6. Use the timeseries API instead. To get all metrics for a service with the timeseries API use the query:

'select * where serviceName = $SERVICE_NAME'.

To get specific metrics for a service use a comma-separated list of the metric names as follows:

'select $METRIC_NAME1, $METRIC_NAME2 where serviceName = $SERVICE_NAME'.

For more information see the tsquery language documentation.

Fetch metric readings for a particular service.

By default, this call will look up all metrics available for the service. If only specific metrics are desired, use the metrics parameter.

By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.

When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available for the service, even if no readings are available in the requested window.

HDFS services that have more than one nameservice will not expose any metrics. Instead, the nameservices should be queried separately.


name description type default
serviceName The name of the service. path
from Start of the period to query. query
to End of the period to query. query now
metrics Filter for which metrics to query. query
view The view of the data to materialize, either "summary" or "full". query summary
clusterName (no documentation provided) path

Response Body

element: metricList

List of readings from the monitors.