Introduction to InterCloud Portal Metrics

What is a Metric ?

The metrics API endpoint objective is to provide a way to require metrics or KPIs from different monitoring back-ends, without having to deal with their request formats.

The metrics API endpoint is organized from the measured resources.

The process is:

1. get the monitored resource unique InterCloud identifiant (IRN, see next section)
2. get the list of available metrics for this resource
3. run the metric to retrieve data

What is an IRN ?

IRN stands for InterCloud Resource Name.

An IRN is an unique identifier (string format) that helps in a specific resource identification.

It gathers the resource family information, the resource owner and a unique identifier.

Please find below an example of IRN:

irn:geoentrypoint:1hv0g4w1k2rkg::t2cxj9

What are the available Metric Types ?

The InterCloud portal provides 2 types of measurements:

• timeseries: this type of metric provides a list of measures with timestamps (example: input or output bandwidth of a connector, measurement of the jitter)
• status: this type of metric provides a specific status of a resource (example: BGP session is up or down)

There are several different measurement metrics for each type of metrics.

How to Run a Metric ?

The request format to run a specific metric is:

GET /metrics/query/irn/<irn>/latency/run?start-d=<s_timestamp>&end-d=<e_timestamp>

The parameters are:

• <irn>: this is the IRN value of the monitored resource
• <s_timestamp>: this is a timestamp to start the monitoring scale
• <e_timestamp>: this is a timestamp to end the monitoring scale

Example:

GET /metrics/query/irn/irn:links:1jeqjrcewkrkg::3u217p/latency/run?start-d=2019-03-17T12:03:01%2B01:00&end-d=2019-03-18T12:03:01%2B01:00