GET /api/monitoring/metrics/summary

Description

This method gets metric totals for a Metric Group Type (or specific named group) for a time window. Totals metrics give a total count for the metric values since the API Server when started. Totals metrics may be used to give a summary of metric data. They should not be used to graph metric data over time. The set of values returned will depend on the type of the metric group, as different metrics are generated for different metric group types.

The Monitoring API resides in the API Servers, therefore this method must be invoked via the Routing API in the Admin Node Manager.

---

Resource URL

https://localhost:8090/api/router/service/{serviceID}/api/monitoring/metrics/summary
https://localhost:8090/api/router/service/{serviceID}/api/monitoring/metrics/summary?metricGroupType={type}&name={name}&from={from}&timeline={timeline}
timeline
***

Parameters

metricGroupType	optional	The metric group type, e.g. "Service", "Client", "TargetServer". This defaults to SystemOverview.
name	optional	The metric group name. If the name is not specified, it sums all of the groups of the metricGroupType together.
from	optional	An ISO-8601 standard web date (e.g. 2012-04-11T14:09:50Z) or a reference (e.g. 5minutes) If not specified, it defaults to the full timeline interval.
timeline	optional	The time window interval; one of 10m, 10h, 5d This defaults to 10m.

---

Response Codes

Response Code	Description
200	Success. The response body contains a list of maps of metrics.

---

Example Request and Response

GET https://localhost:8090/api/router/service/instance-1/api/monitoring/metrics/summary?metricGroupType=TargetServer

HTTP 1.1 200 OK

{
    "result": [
        {
            "groupType": "TargetServer",
            "respTimeAvg": 281,
            "gatewayGroupName": "Group1",
            "groupName": "www.webservicex.com:80",
            "numReportedUps": 8,
            "numReportedDowns": 0,
            "volumeBytesOut": 5296,
            "respTimeMax": 294,
            "respTimeMin": 235,
            "numOutConnections": 0,
            "numInConnections": 0,
            "gatewayName": "APIServer1",
            "name": "www.webservicex.com:80",
            "volumeBytesIn": 8920,
            "numTransactions": 8,
            "gatewayId": "instance-1"
        },
        {
            "groupType": "TargetServer",
            "respTimeAvg": 0,
            "gatewayGroupName": "Group1",
            "groupName": "stockquote.com:80",
            "numReportedUps": 0,
            "numReportedDowns": 0,
            "volumeBytesOut": 0,
            "respTimeMax": 0,
            "respTimeMin": 0,
            "numOutConnections": 0,
            "numInConnections": 0,
            "gatewayName": "APIServer1",
            "name": "stockquote.com:80",
            "volumeBytesIn": 0,
            "numTransactions": 0,
            "gatewayId": "instance-1"
        }
    ]
}