Objetivo

Esta funcionalidad permite monitorizar el consumo individual y en conjunto de los notebooks. De esta forma podremos conocer el estado de cada Notebook, ver los procesos en ejecución, controlar el estado…

Funcionamiento de los Notebooks

Para entender la funcionalidad de Monitorización es importante conocer algunos conceptos de los Notebooks.

Modos de ejecución de notebooks

Los notebooks de plataforma (basados en Apache Zeppelin) se ejecutan en base a intérpretes con diferentes configuraciones, de modo que un notebook, puede ejecutar intérpretes en diferentes modos.

En plataforma se contemplan 3 modos de ejecución de intérpretes en notebooks:

Shared → El proceso del intérprete, se comparte con todos los notebooks, de modo que no se pueden hacer ejecuciones paralelas de este intérprete en varios notebook. El manager es el mismo para ese intérprete. En estos casos, al no estar asociado el intérprete a un notebook, no podrá saberse de forma sencilla cuál es el notebook que ha ejecutado, ya que podrá ir saltando de unos a otros y tendrá que cruzarse la entidad de recursos con la entidad de ejecuciones para poderse conocer el detalle.
Por notebook:
- Scoped → El proceso del intérprete es común para todos los notebooks por lo tanto es un manager de varias ejecuciones.
- Isolated → El proceso del intérprete está separado también por notebook con lo que el manager sólo maneja un notebook. En este caso, el intérprete estará asociado a un notebook con lo que se podrá saber que notebook es en todo momento por el nombre del intérprete. Si se quiere saber el detalle de párrafos habrá que cruzar la entidad de recursos con la de ejecuciones.

Además, existen los modos de ejecución en k8s de modo que la ejecución de cada notebook se delega en cada pod. El manager se mantiene en este pod a modo de control de los diversos tipos de ejecuciones.

En base a esto, será el manager (proceso RemoteInterpreterServer) el encargado de reportar la información de métricas y ejecuciones a plataforma, independientemente de donde se ejecute.

Métricas disponibles

Se han creado 2 métricas, ambas complementarias:

Métricas de recursos

Esta monitorización, almacenada en una entidad de tipo TimeSeries (notebooks_metrics_resources). A nivel intérprete, se sacan los procesos, tipo de intérprete (shared, scoped, isolated), si está asociado a un notebook y el consumo de CPU y RAM

Tiene un reporte periódico (configurable a nivel pod del módulode notebooks), por defecto, estará a 10 segundos.

En intérpretes “shared“, será necesario cruzar con la entidad de monitorización para saber que notebook ha consumido el intérprete.

Métricas de ejecución

Estas métricas (notebooks_metrics_executions) dan el detalle de ejecución de los párrafos que se ve el usuario, notebook, párrafo, intérprete...

Esta monitorización hará de “history“ de ejecuciones, se almacenará en una entidad propia y podrá ser desactivada si no se cree necesaria.

Con esta monitorización, cruzada con la anterior, podremos saber el consumo real por párrafo.

Reporte de Métricas

Para el reporte de métricas existen dos métodos:

Reporte push desde intérprete → a traves de estas variables de entorno (incluidas en el zeppelin-env.sh) se configura el acceso, vía digital client, a dos entidades sobre las que se insertarán las métricas anteriores.

#### Monitor reporter zeppelin onesait platform ####
export ZEPPELIN_INTERPRETER_MONITORREPORTER_ENABLE=true
export ZEPPELIN_INTERPRETER_MONITORREPORTER_DIGITALCLIENT_HOST=https://development.onesaitplatform.com/iot-broker
export ZEPPELIN_INTERPRETER_MONITORREPORTER_DIGITALCLIENT_NAME=notebook_metrics_client
export ZEPPELIN_INTERPRETER_MONITORREPORTER_DIGITALCLIENT_INSTANCE=notebook_metrics_client_interpreter
export ZEPPELIN_INTERPRETER_MONITORREPORTER_DIGITALCLIENT_TOKEN=XXXXXXX
export ZEPPELIN_INTERPRETER_MONITORREPORTER_ENTITY_RESOURCES=notebook_metrics_resources
export ZEPPELIN_INTERPRETER_MONITORREPORTER_ENTITY_EXECUTIONS=notebook_metrics_executions

Reporte desde API Rest de zeppelin → a través de un nuevo api creado (tipo actuator) se puede conocer el consumo de todos los intérpretes (métrica de recursos). En este caso, no es posible obtener la métrica de ejecución al depender en si de la temporalidad de la misma.

Se disponen de varios endpoints:

/api/interpreter/metrics/all → obtener todos los recursos de los intérpretes de zeppelin así como su estado y consumo

/api/interpreter/metrics/running → obtener todos los recursos de los intérpretes arrancados de zeppelin así como su estado y consumo

/api/interpreter/metrics/notebook/{notebookId} → obtener todos los recursos de los intérpretes de zeppelin para el notebook parametrizado así como su estado y consumo

/api/interpreter/metrics/running/notebook/{notebookId} → obtener todos los recursos de los intérpretes arrancados de zeppelin para el notebook parametrizado así como su estado y consumo

/api/interpreter/metrics/interpreter/{interpreterId} → obtener todos los recursos del intérprete por id (python, spark, onesaitplatform, …) así como su estado y consumo

Próximos pasos

Tener controles sobre los mismos en plataforma (UI de los notebooks) → poder usar los elementos anteriores en la UI de los notebooks para conocer los activos, poder pararlos de forma sencilla, etc, etc
Dashboard de visualización de métricas de forma sencilla
Limitar el uso de procesos de notebooks tanto por RAM como por CPU

platform-doc-es

Monitorización en Notebooks Engine