GET /api/monitoring/metrics/groups

Description

A Metric Group identifies some system entity for which we are recording a set of metrics, e.g a web service, an external API, an authenticated client, an external target server etc. This method will return a list of all Metric Groups currently being monitoring by the API Server.

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/groups
https://localhost:8090/api/router/service/{serviceID}/api/monitoring/metrics/groups?type={type}

---

Parameters

type

optional

Filter the returned metric groups by type, e.g. "Service", "Client", "TargetServer". This defaults to get all types of metric groups.

---

Response Codes

Response Code	Description
200	Success. The response body contains a list of metric groups. Refer to Javadoc for com.vordel.api.monitoring.model.MetricGroup.

---

Example Request and Response

GET https://localhost:8090/api/router/service/instance-1/api/monitoring/metrics/groups

HTTP 1.1 200 OK

{
    "result": [
        {
            "id": 12,
            "name": "AccumalativeAuthenticatedClientsCount",
            "type": "Clients",
            "parentId": 0
        },
        {
            "id": 14,
            "name": "8080",
            "type": "InboundProtocol:http",
            "parentId": 0
        },
        {
            "id": 15,
            "name": "admin",
            "type": "InboundProtocolUsagePerClient",
            "parentId": 0
        },
        {
            "id": 13,
            "name": "AccumalativeWebServiceCount",
            "type": "Services",
            "parentId": 0
        },
        {
            "id": 6,
            "name": "System overview",
            "type": "SystemOverview",
            "parentId": 0
        },
        {
            "id": 11,
            "name": "admin",
            "type": "Client",
            "parentId": 0
        },
        {
            "id": 7,
            "name": "www.webservicex.com:80",
            "type": "TargetServer",
            "parentId": 0
        },
        {
            "id": 8,
            "name": "stockquote.com:80",
            "type": "TargetServer",
            "parentId": 0
        },
        {
            "id": 9,
            "name": "StockQuote",
            "type": "Service",
            "parentId": 0
        },
        {
            "id": 10,
            "name": "admin",
            "type": "ServiceUsagePerClient",
            "parentId": 0
        }
    ]
}