Las APIs que tengan el plugin de HttpLog activado, tendrán sus consultas guardadas en la base de datos de api management, bajo el modelo de Django Query. Estos datos se disponibilizan de diferentes maneras. Para información adicional, ver Analytics.
Es posible, con una penalidad en el rendimiento de la API, lograr guardar todas las llamadas que se hacen a la misma. En el panel “kong plugin HTTP logs” podremos activar esta funcionalidad. Primero debemos proveer una api key para que puedan guardarse los registros de las llamadas, y finalmente debemos activar la funcionalidad al tildar el campo enabled.
Las llamadas a la aplicación serán registradas bajo la sección “Analytics”, en el modelo Query.
Los analytics de las apis con logs activados se obtienen haciendo GET /management/api/analytics/queries/.
Este endpoint requiere autenticacion por token, interno de Kong. No es posible generarlo a través de la interfaz de API Management.
Se puede obtener un token con curl -X POST <kong>/management/api/token/ -d username=<username> -d password=<password>
Para autenticarse enviar el token en el header Authorization: Token <token>.
Se pueden obtener queries con curl -X GET <kong>/management/api/analytics/queries/ -H 'Authorization: Token <token>'
| Parametro | Descripcion |
|---|---|
| cursor | Indica desplazamiento de pagina por cursor |
| kong_api_id | Id de api que se quiere filtrar. |
Respuesta:
HTTP 200 OK
{
"next": "http://<kong>/management/api/analytics/queries/?cursor=xxxxxxx",
"previous": null,
"results": [
{
"id": 1,
"ip_address": "123.123.123.123",
"host": "datos.gob.ar",
"uri": "/series/v1/series/",
"api_data": 1,
"querystring": "",
"start_time": "2018-01-05T13:30:00-03:00",
"request_time": "0.0001220000000000000000000",
"status_code": 200,
"user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:59.0) Gecko/20100101 Firefox/59.0"
}
]
}
Todos los días, en el ambiente de deploy, se ejecuta el comando python manage.py generate_analytics para generar un archivo .csv el cual contiene la información de todas las Query que se hicieron el día anterior. Si se busca generar todos los analytics desde la primer Query realizada, hay que corre el comando python manage.py generate_analytics --all. Esto recorre todas las Query de la DB y genera un archivo .csv por día para cada una de ellas. Es un proceso asincrónico, por lo tanto, va a correr cuando los workers estén disponibles más allá de ver el mensaje en pantalla “Generando csv….”. Este CSV puede accederse en el endpoint /management/api/analytics/<kong_api_name>/analytics_<fecha>.csv, por ejemplo: /management/api/analytics/series/analytics_2018-06-30.csv
Todos los días, en el ambiente de deploy, se ejecuta el comando python manage.py generate_indicators para generar un archivo .csv el cual contiene la información de los indicadores por APIs. Cada row representa un día. Es un proceso asincrónico, por lo tanto, va a correr cuando los workers estén disponibles más allá de ver el mensaje en pantalla “Generando csv….”. Este CSV puede accederse en el endpoint /management/api/analytics/<kong_api_name>_indicadores.csv, por ejemplo: /management/api/analytics/series-tiempo-indicadores.csv
Si por alguna razón se quieren borrar analytics, por ejemplo después de un test de stress, se puede utilizar el comando de django delete_analytics. Éste acepta una dirección IP y una fecha, y borra todos los registros asociados a esos dos parámetros.
La fecha debe estar en formato YYYY-MM-DD (ISO8601)
Ejemplo ./manage.py delete_analytics 192.168.254.254 2019-01-01