API (v2) Metrics

The separate API endpoint /v2/metrics allows access to server metrics data such as CPU-utilization, memory usage, network traffic as well as memory utilization.

From localhost it can be accessed without authentication:

Metrics data (localhost access)

curl -sk https://127.0.0.1:9092/v2/metrics | jq

Response (success):

{
    "aggnet": [
        {
            "labels": [],
            "name": "receive_bytes_total_vlan-br0.1",
            "value": 28239920801
        },
        {
            "labels": [],
            "name": "transmit_bytes_total_vlan-br0.1",
            "value": 7680607520
        }
    ],
    "shortdisk": [
        {
            "name": "disk_io_now_loop0p2",
            "value": 0
        },
        {
            "name": "disk_io_now_nbd0p2",
            "value": 0
        }
    ],
    "shortload": [
        {
            "labels": [],
            "name": "node_load1",
            "value": 0.1000000000000000055511151231257827021181583404541015625
        },
        {
            "labels": [],
            "name": "node_load5",
            "value": 0.190000000000000002220446049250313080847263336181640625
        },
        {
            "labels": [],
            "name": "node_load15",
            "value": 0.270000000000000017763568394002504646778106689453125
        }
    ],
    "shortmem": [
        {
            "labels": [],
            "name": "node_memory_MemTotal_bytes",
            "value": 66880827392
        },
        {
            "labels": [],
            "name": "node_memory_MemAvailable_bytes",
            "value": 50891743232
        },
        {
            "labels": [],
            "name": "node_memory_MemFree_bytes",
            "value": 2547236864
        },
        {
            "labels": [],
            "name": "node_memory_SwapTotal_bytes",
            "value": 33776726016
        },
        {
            "labels": [],
            "name": "node_memory_SwapFree_bytes",
            "value": 33776726016
        }
    ]
}

Metrics data (from remote)

1.) Use LOGIN first to get a TOKEN:

curl -sk -X POST https://API_IP:9092/v2/cce -H "Content-Type: application/json" -H "X-Client-Secret: YOUR-CLIENT-SECRET" -d '{"cmd": "LOGIN"}' | jq

2.) Then use your CLIENT-SECRET and TOKEN to make the API call:

curl -sk https://API-IP:9092/v2/metrics -H "X-Client-Secret: CLIENT-SECRET" -H "X-Token: TOKEN" | jq

Response (success):

{
    "aggnet": [
        {
            "labels": [],
            "name": "receive_bytes_total_vlan-br0.1",
            "value": 28239920801
        },
        {
            "labels": [],
            "name": "transmit_bytes_total_vlan-br0.1",
            "value": 7680607520
        }
    ],
    "shortdisk": [
        {
            "name": "disk_io_now_loop0p2",
            "value": 0
        },
        {
            "name": "disk_io_now_nbd0p2",
            "value": 0
        }
    ],
    "shortload": [
        {
            "labels": [],
            "name": "node_load1",
            "value": 0.1000000000000000055511151231257827021181583404541015625
        },
        {
            "labels": [],
            "name": "node_load5",
            "value": 0.190000000000000002220446049250313080847263336181640625
        },
        {
            "labels": [],
            "name": "node_load15",
            "value": 0.270000000000000017763568394002504646778106689453125
        }
    ],
    "shortmem": [
        {
            "labels": [],
            "name": "node_memory_MemTotal_bytes",
            "value": 66880827392
        },
        {
            "labels": [],
            "name": "node_memory_MemAvailable_bytes",
            "value": 50891743232
        },
        {
            "labels": [],
            "name": "node_memory_MemFree_bytes",
            "value": 2547236864
        },
        {
            "labels": [],
            "name": "node_memory_SwapTotal_bytes",
            "value": 33776726016
        },
        {
            "labels": [],
            "name": "node_memory_SwapFree_bytes",
            "value": 33776726016
        }
    ]
}

Please note:

The data that is reported back is fetched by CCEd-API exactly at the time when your API-call is received. CCEd-API keeps no track of historical metrics and always reports only the current values.