Cómo utilizar la API de vScope

Última actualización: 18/11/2020

Objetivo

OVHcloud pone a su disposición una herramienta de supervisión y monitorización de sus máquinas virtuales y de su infraestructura llamada vScope.

Se trata de una página web en la que se recopila toda la información necesaria sobre el uso de sus recursos.

Esta información también se encuentra disponible en la APIv6 y la API Metrics.

Esta guía explica cómo utilizar estas API.

Requisitos

• Tener una infraestructura Managed Bare Metal.
• Estar conectado a la interfaz vScope.

Procedimiento

La herramienta vScope proporciona dos tipos de información:

• Información live, que corresponde a los datos de los diferentes componentes en un momento determinado.
• Gráficos que presentan los datos históricos de rendimiento de los diferentes componentes como, por ejemplo, la CPU y la RAM de una máquina virtual.

Recopilar los datos live

Los datos live son aquellos que se encuentran disponibles en la página principal de la interfaz vScope.

Podrá obtener los datos live para los siguientes componentes:

• filers;
• hosts;
• máquinas virtuales.

El uso de la API se realiza a través de estas tres llamadas APIv6:

Filers

Hosts

Máquina virtual

Recopilar los datos históricos (Graphs)

Para recopilar y utilizar los datos históricos (Graphs), puede utilizar la solución Metrics Data Platform.

Mediante el protocolo Opentsdb o WARP10, podrá obtener sus datos en forma de puntos. Asimismo, podrá utilizarlos a través de su aplicación o verlos directamente según el renderizado deseado.

En esta guía explicaremos el uso del protocolo Opentsdb para obtener una visualización de datos en bruto (sin renderizado gráfico).

Para poder utilizar Metrics Data Platform, necesitará un token de lectura. Con la nueva versión del vScope, cada usuario de la infraestructura dispone de un token de lectura.

Para el usuario deseado, utilice la siguiente llamada a la APIv6 y obtenga el token de lectura:

Su token se encuentra en el campo token del resultado.

{
    "warpEndpoint": "https://warp10.gra1-ovh.metrics.ovh.net",
    "token": "XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX",
    "opentsdbEndpoint": "https://opentsdb.gra1-ovh.metrics.ovh.net"
}

Para cada tipo de componente, existe una lista de métricas y necesita un número muy preciso de parámetros (también llamados labels).

Filers

Hosts

Máquinas virtuales

Ejemplo de recopilación con el protocolo OpenTSDB

Una vez que obtuvo su token, su endpoint y su lista de métricas, recuperará los datos de uso de memoria de un host en un día.

A continuación, encontrará un ejemplo de petición.

curl -XPOST https://read:XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX@opentsdb.gra1-ovh.metrics.ovh.net/api/query
-d '{ 
    "start":1564407950, 
    "queries":[ 
        { 
            "metric":"vscope.host.mem.usage.perc", 
            "aggregator":"sum",
            "downsample":"20m-max-zero",
            "tags": {
                "datacenter":"pcc-37-187-228-180_datacenter869",
                "host":"172.17.86.51" 
            } 
        } 
    ] 
}'

Explicación de los diferentes campos utilizados:

• read: usuario utilizado para efectuar la petición (siempre será read);
• XXXXXXXXXXXX_XXXXXXXXXXXZZZZZZZZZZZ_YYYYYYYYYYYYYY-XXXXXXXXX: token previamente obtenido mediante la APIv6;
• opentsdb.gra1-ovh.metrics.ovh.net: endpoint OpenTSDB, también obtenido mediante la APIv6. Este endpoint puede variar según su localización;
• start: marcas de tiempo que corresponden a la fecha de inicio de la petición;
• queries: tabla que contiene las métricas por obtener. Se pueden recuperar varias métricas en una sola petición;
• metric: nombre de la métrica por obtener;
• aggregator: nombre de la función de agregación (consultar la documentación OpenTSDB para más información);
• downsample: nombre de la función de muestreo (permite reducir el número de datos por recuperar. Parámetro optativo);
• tags: lista de labels (etiquetas) en forma de llave / valor;

También pueden suministrarse otros parámetros. Por favor, consulte la documentación de la API OpenTSDB para más información.

A su vez, recibirá un JSON con el resumen de la petición, como también las marcas de tiempo asociadas a su valor en el campodps. Ejemplo:

[
    {
        "metric":"vscope.host.mem.usage.perc",
        "tags":{
            "datacenter":"pcc-37-187-228-180_datacenter869",
            "env":"prod",
            "host":"172.17.86.51",
            "servicename":"pcc-37-187-228-180",
            "servicetype":"vscope"
        },
        "query":{
            "index":0
        },
        "aggregateTags":[],
        "dps":{
            "1564409391":4.38,
            "1564410591":4.35,
            "1564411791":4.37,
            "1564412991":4.38,
            "1564414191":4.35,
            "1564415391":4.38,
            "1564416591":4.35,
            "1564417791":4.36,
            "1564418991":4.36,
            "1564420191":4.37,
            "1564421391":4.37,
            "1564422591":4.37,
            "1564423791":4.37,
            "1564424991":4.38,
            "1564426191":4.36,
            "1564427391":4.35,
            "1564428591":4.37,
            "1564429791":4.36,
            "1564430991":4.38,
            "1564432191":4.35,
            "1564433391":4.37,
            "1564434591":4.36,
            "1564435791":4.37,
            "1564436991":4.37,
            "1564438191":4.37,
            "1564439391":4.38,
            "1564440591":4.36,
            "1564441791":4.36,
            "1564442991":4.37,
            "1564444191":4.37,
            "1564445391":4.35,
            "1564446591":4.36,
            "1564447791":4.36,
            "1564448991":4.36,
            "1564450191":4.35,
            "1564451391":4.37,
            "1564452591":4.37,
            "1564453791":4.35,
            "1564454991":4.36,
            "1564456191":4.37,
            "1564457391":4.37,
            "1564458591":4.36,
            "1564459791":4.37,
            "1564460991":4.34,
            "1564462191":4.36,
            "1564463391":4.34,
            "1564464591":4.37,
            "1564465791":4.34,
            "1564466991":4.37,
            "1564468191":4.34,
            "1564469391":4.36,
            "1564470591":4.36,
            "1564471791":4.36,
            "1564472991":4.37,
            "1564474191":4.37,
            "1564475391":4.36,
            "1564476591":4.35,
            "1564477791":4.36,
            "1564478991":4.35,
            "1564480191":4.35,
            "1564481391":4.37,
            "1564482591":4.36,
            "1564483791":4.34,
            "1564484991":4.37,
            "1564486191":4.38,
            "1564487391":4.35,
            "1564488591":4.34,
            "1564489791":4.36,
            "1564490991":4.35,
            "1564492191":4.36,
            "1564493391":4.36,
            "1564494591":4.36
        }
    }
]

Para más información sobre las peticiones OpenTSDB, consulte la siguiente documentación: OpenTSDB api query

Más información

Interactúe con nuestra comunidad de usuarios en https://community.ovh.com/en/.

Otras guías que podrían interesarle...