How to retrieve Links Metrics ?
Get Links IRN
The request route to get the links list for a given group is:
GET /link/group/3247aade-d579-48cd-9459-ed818b5a0525
It provides a response which lists all links with individual information:
[
{
"id": "4b9c6c3d-37e0-421a-a1e1-1d1be84e8ec9",
"created_at": "2019-03-11 08:22:41.387672 +0000 UTC",
"updated_at": "2019-03-11 08:22:41.387672 +0000 UTC",
"irn": "irn:links:urejt82ajhco::1tfjjjn",
"name": "LINK-INTERCLOUD-DUBLIN-AWS",
"description": "LINK-INTERCLOUD-DUBLIN-AWS",
"tagIds": null,
"from": "389bf518-beac-4a8f-b33c-98b2f0220258",
"to": "f4f85588-82c5-40be-9adf-de758ff816e8"
},
{
"id": "77a5c058-cbe2-4604-a59d-b3861489432a",
"created_at": "2019-03-11 08:22:41.66323 +0000 UTC",
"updated_at": "2019-03-11 08:22:41.66323 +0000 UTC",
"irn": "irn:links:urejt82ajhco::1tfine9",
"name": "LINK-INTERCLOUD-AMSTERDAM-AZURE",
"description": "LINK-INTERCLOUD-AMSTERDAM-AZURE",
"tagIds": null,
"from": "4b168282-f36b-4b28-9a67-189d934d06c1",
"to": "f4f85588-82c5-40be-9adf-de758ff816e8"
}
]
Get Link Metrics
The following request list all available metrics for a link:
GET /metrics/query/irn/irn:links:skstok62tbks::1s2w551
The response looks like:
[
{
"name": "latency",
"type": "timeserie"
},
{
"name": "packet_loss",
"type": "timeserie"
},
{
"name": "jitter",
"type": "timeserie"
}
]
latency: delay that happens over a linkpacket_loss: number of lost packet over a time period over a given linkjitter: variance in time delay that happens over a link
Run Link Metrics
The request to run a status metric, for example, is:
GET /metrics/query/irn/irn:links:1hv0g4w1k2rkg::1s2w551/latency/run?start-d=2019-03-11T13:15:47%2B01:00&end-d=2019-03-18T13:15:47%2B01:00
The response is (timeseries metric type):
{
"type": "timeserie",
"measure": "Latency",
"axis": {
"mean": {
"unit": "ms",
"title": ""
}
},
"Results": [
{
"Series": [
{
"name": "ping_sondes",
"columns": [
"time",
"mean"
],
"values": [
[
"2019-03-20T12:20:00Z",
13.546
],
[
"2019-03-20T12:25:00Z",
13.562800000000001
],
[
"2019-03-20T12:30:00Z",
13.5782
],
...