How to retrieve Connectors Metrics ?
Get Connector IRN
The request route to get the connectors list is:
GET /connectors
It provides a response which lists all connectors with individual information:
[
{
"id": "e011088b-b41c-4486-b3b7-2a86a9c4136d",
"connectorType": "virtualGateway",
"connectorTypeId": "81467636-c6c2-45c1-9689-d56fafb8f3be",
"irn": "irn:connectors:1hv0g4w1k2rkg::swzehj",
"name": "VRF-CST-INTERCLOUD-012--AZURE-16",
"description": "VRF-CST-INTERCLOUD-012--AZURE-16",
"tagIds": null,
"organisationId": "81a88c9d-d94d-41e1-a4b6-3e9ebbb3a822",
"groupId": "80ae7ebc-11a3-4d91-a905-5bc2435bbbe9",
"region": "Europe",
"slug": "europe",
"longitude": 2.3506622,
"latitude": 48.9269417,
"routerIrn": "irn:geoentrypoint:1hv0g4w1k2rkg::swza2k",
"bgpDescriptions": [
"CST-INTERCLOUD-012-AZURE-BGP-CPE-DC2-PRIMARY"
],
"routerInterface": [
"CST:INTERCLOUD::MX-DC2:XE-0/1/0::INTERCLOUD-012:AZURE:PRIMARY"
]
}
]
The IRN can be found in the key irn: "irn:connectors:1hv0g4w1k2rkg::swzehj"
Get Connector Metrics
The following request list all available metrics for a group:
GET /metrics/query/irn/irn:connectors:1hv0g4w1k2rkg::swzehj
The response is:
[
{
"name": "bits_send",
"type": "timeserie"
},
{
"name": "bits_received",
"type": "timeserie"
},
{
"name": "connStatusHistory",
"type": "timeserie"
},
{
"name": "connStatus",
"type": "status"
}
]
bit_sends: is the input bandwidth for this connectorbit_received: is the output bandwidth for this connectorconnStatus: is the last known BGP sessions status for this connectorconnStatusHistory: is the history of the BGP sessions status for this connector (number of measure points Up and Down per day)
Run Connector Metrics
The request to run a status metric, for example, is:
GET /metrics/query/irn/irn:connectors:1hv0g4w1k2rkg::swzehj/connStatus/run?start-d=2019-03-11T13:15:47%2B01:00&end-d=2019-03-18T13:15:47%2B01:00
The response is (status metric type):
{
"type": "JSONSchemeForConnectors",
"results": [
{
"data": {
"bgpName": "BGP peer - CST-INTERCLOUD-002-AZURE-AMSTERDAM-PARIS-SECONDARY",
"bgpStatus": 0,
"hostName": "hostname.intercloud.fr",
"hostStatus": 0
}
},
{
"data": {
"bgpName": "BGP peer - CST-INTERCLOUD-002-AZURE-AMSTERDAM-PARIS-PRIMARY",
"bgpStatus": 0,
"hostName": "hostname.intercloud.fr",
"hostStatus": 0
}
}
]
}