.. _mqtt: MQTT Thresholds =============== La integración con **MQTT** permite incorporar a WOCU-Monitoring la monitorización pasiva de dispositivos, especialmente orientada a entornos **IoT** (*Internet of Things*). A diferencia de los mecanismos de monitorización activa donde WOCU-Monitoring consulta periódicamente al dispositivo, en este modelo son los propios dispositivos los que publican información en un broker MQTT. WOCU-Monitoring consume posteriormente estos datos y los incorpora al Reino correspondiente en forma de **Servicios Pasivos**. De este modo, es posible integrar dispositivos que envían métricas o estados de monitorización a través de MQTT sin necesidad de disponer previamente de un Pack de monitorización específico. WOCU-Monitoring incorpora la **vista MQTT Thresholds**, donde se recopilan todos los servicios generados automáticamente a través de la integración MQTT. Aquí, el usuario puede consultar los servicios existentes y configurar de forma individual sus umbrales Warning y Critical, que determinarán el estado del servicio en función de los valores recibidos. .. image:: ../images/setup/configuration_mqptt_tab_75.png :align: center Funcionamiento -------------- El flujo general de funcionamiento es el siguiente: - Los dispositivos del cliente publican información en el broker MQTT utilizando las :ref:`credenciales configuradas para el Reino`. - Cada mensaje incorpora un identificador de sitio (``MQTT Site ID``), que permite determinar a qué Reino debe asociarse la información recibida. - El servicio MQTT de WOCU-Monitoring consume los mensajes y los enruta automáticamente al Reino correspondiente según el ``MQTT Site ID``. - WOCU-Monitoring procesa los datos recibidos y genera automáticamente los Hosts y/o **Servicios Pasivos** necesarios. - Los nuevos servicios quedan disponibles para su consulta desde el :ref:`hostsinventory` y desde la vista :ref:`MQTT Thresholds`, donde pueden configurarse sus umbrales de estados Warning y Critical (acción de edición). .. important:: Los servicios recibidos a través de MQTT se incorporan automáticamente a WOCU-Monitoring, por lo que no es necesario crearlos manualmente. .. _mqtt_conf_realm: Preconfiguración MQTT del Reino ------------------------------- La configuración necesaria para habilitar la comunicación MQTT se realiza desde el **WM Console Admin**, dentro de la configuración avanzada del Reino. Se accede desde el :ref:`main-bar`, a través del desplegable :ref:`settings`, seleccionando la opción :ref:`advanced_configuration`. .. image:: ../images/administrator_guide/7_004_configuration_69.png :align: center Una vez dentro acceda a: **Aggregator** > **Realms** > dentro de un Reino concreto diríjase a la sección **MQTT configuration**. .. image:: ../images/setup/configuration_mqtt_internal_configuration_75.png :align: center La sección **MQTT configuration** incluye los siguientes parámetros: .. list-table:: :widths: 25 75 :header-rows: 1 * - Campo - Descripción * - **MQTT Username** - Nombre de usuario empleado para autenticarse en el broker MQTT. Esta credencial deberá proporcionarse al cliente para configurar la comunicación desde sus dispositivos o sistemas. * - **MQTT Password** - Contraseña asociada al usuario MQTT. Junto con **MQTT Username**, permite autenticar al cliente frente al broker. * - **MQTT Site ID** - Identificador único asociado al Reino. Debe incluirse en la información enviada a MQTT para que WOCU-Monitoring pueda determinar a qué Reino debe dirigir los datos recibidos. Una configuración incorrecta de este identificador puede impedir que la información sea enrutada al Reino esperado. .. important:: Las credenciales **MQTT Username** y **MQTT Password** deberán facilitarse al cliente para que pueda configurar sus dispositivos o sistemas y establecer la comunicación con el broker MQTT. .. _mqtt_table: Vista MQTT Thresholds --------------------- Los datos recibidos mediante MQTT se incorporan a WOCU-Monitoring en forma de **Servicios Pasivos**, que se crean automáticamente y quedan asociados al Host correspondiente. Dado que la información procede de sistemas externos y puede contener métricas de distinta naturaleza, estos servicios no disponen necesariamente de un Pack de monitorización que permita definir previamente sus condiciones de estado. Para gestionar esta casuística, WOCU-Monitoring incorpora la vista **MQTT Thresholds**, donde se recopilan todos los servicios generados automáticamente a través de la integración MQTT. Desde esta vista, el usuario puede consultar los servicios existentes y configurar de forma individual sus umbrales **Warning** y **Critical**, que determinarán el estado del servicio en función de los valores recibidos. La vista **MQTT Thresholds** está disponible desde: :ref:`Configuration` > :ref:`Monitored Assets` > :ref:`mqtt` .. image:: ../images/setup/configuration_mqptt_tab_75.png :align: center Listado de servicios MQTT ^^^^^^^^^^^^^^^^^^^^^^^^^ La tabla principal presenta los siguientes campos: .. image:: ../images/setup/configuration_mqtt_table_75.png :align: center **Host** Identifica el Dispositivo al que pertenece el servicio pasivo. Al pulsar sobre el nombre se accede a su vista de detalle, donde se muestra la información asociada a la configuración de umbrales aplicada al Servicio Pasivo asociado al dicho dispositivo. .. image:: ../images/setup/configuration_mqtt_view_detail_of_service_75.png :align: center La vista incluye los siguientes campos: * **Passive service id**: identificador interno del Servicio Pasivo. * **Threshold id**: identificador interno de la configuración de umbrales asociada. * **Warning**: valor configurado como umbral de estado **Warning**. * **Critical**: valor configurado como umbral de estado **Critical**. * **Has threshold**: indica si el servicio dispone de una configuración de umbrales activa. Cuando está disponible, se representa mediante un icono de confirmación. **Service** Muestra el nombre del Servicio Pasivo creado a partir de la información recibida mediante MQTT. Un mismo Dispositivo puede disponer de varios servicios MQTT, cada uno de ellos asociado a una métrica o dato diferente. **Imported from** Indica el origen desde el que se ha incorporado el servicio. Para esta integración se muestra el valor ``mqtt``. **Warning** Muestra el umbral a partir del cual el valor recibido debe ser considerado en estado **Warning**. Si no se ha definido ningún umbral, se muestra ``-``. **Critical** Muestra el umbral a partir del cual el valor recibido debe ser considerado en estado **Critical**. Si no se ha definido ningún umbral, se muestra ``-``. Actions: Borrado y Edición de umbrales del Servicio ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ La última columna de la tabla contiene las acciones disponibles para cada servicio MQTT. Estas son: .. image:: ../images/setup/configuration_mqtt_action_75.png :align: center **Edición de los umbrales de servicio** A través del botón con el icono de lápiz es posible modificar los umbrales del servicio desde la vista **Edit MQTT Threshold**, estableciendo los valores asociados a los estados **Warning** y **Critical**. .. image:: ../images/setup/configuration_mqtt_action_edit_75.png :align: center La configuración incluye los siguientes campos: * **Realm name**: Reino de WOCU-Monitoring al que pertenece el Servicio Pasivo MQTT que se está editando. * **Hosts**: Dispositivo al que pertenece el servicio MQTT seleccionado. * **Service**: Servicio Pasivo sobre el que se aplicará la configuración. * **Warning Threshold**: Expresión o valor que determina cuándo el servicio debe pasar a estado **Warning**. * **Critical Threshold**: Expresión o valor que determina cuándo el servicio debe pasar a estado**Critical**. .. admonition:: Aplicación de los umbrales Los umbrales **Warning** y **Critical** se evalúan sobre los valores recibidos por el Servicio Pasivo y admiten la sintaxis de rangos utilizada por **Nagios**. Por ejemplo, si se configura ``Warning Threshold: 40`` y ``Critical Threshold: 50``, los valores superiores a ``40`` generarán un estado **Warning**, mientras que los superiores a ``50`` generarán un estado **Critical**. Una vez guardada la configuración, WOCU-Monitoring aplicará estos umbrales a los nuevos valores recibidos y actualizará automáticamente el estado del Servicio Pasivo cuando se cumplan las condiciones definidas. El cambio de estado podrá consultarse desde las vistas habituales de monitorización, como :ref:`assets_tab` > :ref:`Hosts`, integrándose así los servicios MQTT en el mismo modelo de estados que el resto de elementos monitorizados por WOCU-Monitoring. .. image:: ../images/setup/configuration_host_inventory_example_75.png :align: center **Borrado de los umbrales configurados del servicio** A través del botón con el icono de papelera, es posible eliminar la configuración de umbrales asociada al servicio. Para hacerse efectiva debe confirma la acción a través del botón **Delete**. .. image:: ../images/setup/configuration_mqtt_delete_action_75.png :align: center