Informes

Informes

Versión EnterpriseDentro de un informe, la información a presentar se organiza en elementos de informe. Hay diferentes tipos de elementos que realizan cálculos y presentan información de formas muy distintas.

Aunque generalmente tienen un formulario de configuración muy similar, cada tipo de elemento se configurará de manera independiente. Se puede tener tantos elementos de tipo y estilo como se necesiten.

  • Pandora FMS simplifica la administración de la monitorización mediante los permisos de usuario. Existen varios sistemas de permisos que restringen lo que un usuario puede ver o administrar, el más importante es el concepto de grupos (ya sean grupos predefinidos por Pandora FMS y/o grupos personalizados) combinados con el perfil de cada uno de los usuarios. Preste usted especial atención a las notas sobre el grupo Todos (ALL) a lo largo de toda la documentación.
  • Versión EnterpriseEn la versión 771, o posterior, el “Sistema ACL Enterprise” tiene habilitadas opciones específicas para la administración y manejo de informes con perfiles de usuario personalizados que se adaptan a cualquier necesidad.

Creación de un informe

Menú OperationReportingCustom reportsCreate report. Se le presentará un formulario donde indicar el nombre del informe (Name) y seleccionar el grupo (Group) al que pertenecerá el informe, también si el informe es privado o no (Write access) y la descripción del mismo.

En el campo Write access podrá elegir los derechos de edición del informe:

  • Only the group can edit the report: Solamente el grupo al cual pertenece el informe podrá editarlo.
  • Only the user and the admin user can edit the report: Solamente el autor y un usuario administrador podrán editar el informe.
  • The next group can edit the report : Si escoge esta opción aparecerá una lista donde podrá elegir a algún otro grupo que también podrá editar el informe.

Por defecto el informe será interactivo (marcado como No en Non-interactive Report). Al marcar un informe como no interactivo, el mismo solamente podrá ser enviado por correo electrónico:

Por defecto tiene activadas las opciones de crear una portada (Generate cover page in PDF render) y un índice (Generate index in PDF render) al momento de generar un PDF a partir del informe.

Presione Save para guardar. Una vez hecho esto se tendrá un informe vacío y listo para agregar elementos al mismo mediante los iconos dispuestos sobre el formulario de edición.

Versión 770 o posterior: En la lista de informes (List of reports) al hacer clic en el icono correspondiente de la columna HTML (excepto si el informe no es interactivo) podrá visualizar por pantalla los filtros e informe en sí mismo. Dicho informe podrá ser agregado (o removido) a su lista de informes favoritos (Favorite) haciendo clic en el icono de estrella que acompaña al nombre del informe.

Gestión de informes

Menú OperationReportingCustom reports → icono List of reports.

En la lista de informes registrados, para cada ítem, en la columna Op. se cuenta con las opciones de:

  • Edición.
  • Copiado.
  • Borrado.
  • Selección para borrado masivo con el botón Delete.

Pestaña Main data

Es la única disponible en un Informe nuevo, ya que en esta se definen los datos básicos del informe. Una vez guardado correctamente se tendrá acceso al resto de las pestañas. Estos campos son los mismos tanto para creación de un informe como para su edición.

Al finalizar de crear o editar pulse el botón Update para guardar los datos de los campos.

Pestaña List Items

Se muestra una visión global de todos los ítems que componen un informe. Utilice la subsección Filters para buscar de entre los elementos registrados en el informe; por ejemplo al desplegar la lista de Agents se mostrarán los agentes registrados en ese informe seleccionado.

Los ítems en la lista aparecerán con el orden en que se mostrarán en el informe, este orden puede ser modificado en la subsección Sort items (o ser borrados en la subsección Delete items, véase columna Op.).

  • P. : Posición de los elementos en el informe, este número también se utiliza para operar las subsecciones:
    • Sort items: Se debe marcar primero un ítem para poder ordenar.
    • Delete items: Borra sin necesidad de marcar ítem alguno, solamente se debe indicar el número de posición y si se borrará hacia arriba o hacia abajo.
  • Columnas Type, Agent y Module: Muestran cada valor de cada ítem y al hacer clic en la cabecera de columna permite ordenar (Ascendent o Descendent) según el mismo, véase Sort items.
  • Op.: Muestra los botones para editar o borrar cada ítem y, además, una casilla para selección de cada elemento. Al hacer clic en la casilla en la cabecera de Op. podrá marcar o desmarcar todos los items.

Las columnas Agent y Module aparecen en blanco para algunos tipos de ítem (por ejemplo de tipo S.L.A o de tipo Text): esto es normal.

Pestaña Item editor

Al hacer clic en Item editor se podrá crear un nuevo elemento para el informe seleccionado.

El formulario es dinámico según el tipo de ítem (Type) a crear. Si está editando se pueden modificar todos los campos excepto el tipo.

Si se necesita cambiar el tipo, la forma de hacerlo es eliminar el actual y crearlo de nuevo con las mismas configuraciones.

Los campos comunes a todos los tipos son:

  • Name: Nombre del informe. Se pueden usar las siguientes macros:
    • _agent_ : Nombre del Agente que ha seleccionado en el elemento del informe.
    • _agentdescription_ : Descripción del Agente que ha seleccionado en el elemento del informe.
    • _agentgroup_ : Grupo del Agente que ha seleccionado en el elemento del informe.
    • _address_ : Dirección del Agente que ha seleccionado en el elemento del informe.
    • _module_ : Nombre del Módulo de Agente que ha seleccionado en el elemento del informe.
    • _moduledescription_ : Descripción del Módulo de Agente que ha seleccionado en el elemento del informe.
  • Show item in landscape format (only PDF): Mostrar el artículo en formato apaisado (solo PDF).
  • Page break at the end of the item (only PDF): Salto de página al final del artículo (solo PDF).

Se rellenan los campos según el tipo de elemento seleccionado y para guardar se pulsa Create item.

Ponga atención cuando guarde un ítem: Generalmente queda listo para agregar un ítem nuevo pero si el ítem que se acaba de crear tiene más opciones configurables entonces aparecerá el botón Update item.

Tipos de ítems

Existen distintos tipos de informe:

  • Graphs: Informes con variados tipos de gráficas.
  • IPAM: Informes con datos tomados de la funcionalidad IPAM PFMS.
  • SLA: Informes de Acuerdo de Nivel de Servicio.
  • Forecasting: Informes con predicción de datos.
  • Modules: Se enfocan y orientan a presentar información de los módulos directamente.
  • Grouped: Permite consolidar diferentes fuentes de información para ser presentados.
  • Text / HTML: Para poder insertar encabezados, subtítulos o pie de informe.
  • Alerts: Todo lo relacionado con alertas.
  • Events: Todo lo relacionado con eventos.
  • Inventory: Todo lo relacionado con inventario.
  • Configuration: Informe con los parámetros de funcionamiento de agentes o de grupos.
  • NetFlow: Informes sobre NetFlow y sFlow.
  • Log: Mostrará las entradas de log en el periodo seleccionado.
  • Permissions report: Permite seleccionar usuarios o grupos de usuarios y listar sus nombres, grupos y permisos.
  • NCM: Permite visualizar los cambios de red en la funcionalidad NCM PFMS.

Además en la pestaña Global se podrán agregar varios tipos de informe adicionales.

Pestaña Wizard

Versión EnterpriseEsta pestaña permite realizar un informe completo de forma automática, con pocos clic. Aplicando configuraciones comunes, se pueden generar elementos aplicados a multitud de agentes y/o módulos.

De nuevo este formulario es dinámico de acuerdo al tipo de informe elegido en la lista Type:

  • Graphs.
  • Forecasting.
  • Modules.
  • Grouped.
  • Alerts.
  • Events.

Una vez elegido el tipo de informe, el periodo, los agentes y si fuera necesario los módulos, al pulsar el botón Add se generarán tantos ítems en el informe como agentes y/ o módulos haya seleccionado.

Pestaña Wizard SLA

Este asistente permite crear específicamente ítems de informe SLA de manera automática.

  • SLA: Mostrará un elemento de informe SLA estándar, indicando el % de cumplimiento en el periodo seleccionado.
  • Monthly SLA: Mostrará un análisis día a día del mes seleccionado, indicando el % de cumplimiento.
  • Weekly SLA: Mostrará un análisis del % de cumplimiento semana a semana, indicando en todo momento el valor diario.
  • Hourly SLA: Mostrará un análisis hora a hora del periodo seleccionado.
  • Availability graph: Se generará una gráfica con los datos de disponibilidad de los módulos seleccionados.
  • SLA services: Se creará un nuevo elemento de informe que representa el cálculo de los SLA de los servicios seleccionados.

Podrá elegir los rangos de validez de valor de los módulos a seleccionar. Esta característica le permitirá comprobar el % de tiempo que un módulo ha mantenido valores dentro de rangos específicos.

Si no se definen umbrales, estos se ajustarán de forma dinámica a los umbrales de criticidad de cada módulo.

Aunque quien esté creando el ítem de informe no pertenezca explícitamente al grupo TODOS (ALL), aún así podrá asignar el grupo ALL como filtro de Agentes de los cuales escoger Módulos.

Pestaña Global

En este apartado del informe puede crear elementos de tipo:

  • Exception: Muestra valores de varios módulos que satisfacen una operación lógica (campo Condition).
  • General: Muestra valores de varios módulos ordenados (ascendente o descendente, por nombre de agente) y/o agrupados por nombre.
  • Top N: Muestra N valores discriminados por máximo, mínimo o media sobre el total de módulos añadidos, ordenados ascendente o descendente o por nombre de agente.

De esta forma puede añadir diferentes módulos de diferentes agentes, además de poder elegir la operación a realizar en cada módulo: sumatorio, media, mínimo, máximo.

Aunque quien está creando el ítem de informe no pertenezca explícitamente al grupo TODOS (ALL), aún así podrá asignar el grupo ALL como filtro de Agentes de los cuales escoger Módulos.

Una vez se hayan elegido los parámetros y se haga clic en el botón Add se creará un ítem de informe que contendrá los agentes y módulos seleccionados.

Pestaña Advanced options

En la pestaña de configuración avanzada del informe puede editar varios aspectos visuales del mismo:

  • Personalizar el tipo de fuente.
  • Seleccionar un logo a usar en las cabeceras de los ficheros en formato PDF.
  • Editar el texto de cabecera y del pie de cada página.
  • Editar la portada del informe

Family Font

La fuente por defecto es Times Roman. Para personalizar el tipo de fuente, seleccione la fuente deseada de la lista desplegable. Esta lista se construye a partir de los archivos .ttf contenidos en el directorio:

/var/www/html/pandora_console/enterprise/include/mpdf50b/ttfonts

Puede agregar los archivos de fuentes en formato TTF a este directorio. Deberán tener los permisos correctos para que el usuario con el que se proporciona el servicio web tenga acceso a estos archivos, por defecto apache:apache en sistemas basados en CentOS. Pandora FMS incluye la fuente “code” que visualiza todos los caracteres existentes en UTF8.

Por defecto se utilizará pandora_log.jpg. Puede seleccionar de la lista desplegable cualquiera de los posibles logotipos para decorar la cabecera de cada página PDF. Esta lista se construye a partir de los archivos de imagen contenidos en el directorio:

/var/www/html/pandora_console/images/custom_logo/

Puede agregar los archivos de imagenes a este directorio. Deberán tener los permisos correctos para que el usuario con el que se proporciona el servicio web tenga acceso a estos archivos, por defecto apache:apache en sistemas basados en CentOS.

Macros

Para reutilizar plantillas de edición, puede utilizar las siguientes macros en los campos de texto enriquecido:

  • (_DATETIME_): Se sustituirá por la fecha del momento en que se genera el informe, en el formato de fecha configurado en las opciones generales de Pandora FMS Console.
  • (_REPORT_NAME_): Se sustituirá por el nombre del informe.

Pestaña View report

Esta pestaña muestra el informe en formato HTML, y es igual a la opción HTML view incluida en la lista de informes registrados.

Visualización de un informe

Menú OperationReportingCustom reports → icono List of reports.

Se pueden visualizar los informes en formato HTML, XML, PDF, JSON o CSV en los iconos respectivos de cada columna e ítem de reporte.

Para enviarlos por correo electrónico se hace clic en el icono correspondiente en la columna E-mail y se abrirá un formulario emergente donde se colocará destinatario(s) y de manera opcional un campo de asunto y un campo de mensaje.

Si se necesita enviar el mismo informe a varios destinatarios coloque las direcciones separadas por comas.

Exportar e importar informes

  • Exportar informes: Se realiza desde el menú ManagementResourcesResource exportingReport, desde donde se escoge el informe a exportar y se pulsa el botón Export justo a la derecha. Esta opción genera ficheros de tipo .ptr (internamente en formato XML), solamente con el reporte en sí mismo, sin agentes, datos, imagen de fondo, etcétera.
  • Importar informes: Se puede importar un informe desde un fichero .ptr desde el menú ManagementResourcesResource registration seleccionando el archivo .ptr (en este caso es innecesario utilizar Group filter) y pulsando el botón Upload.

Programación automática de informes

La programación automática de informes está incluida en las Tareas de Consola (Console task).

Para crear una tarea de Consola para enviar informe vaya al menú ManagementDiscoveryNew console task y seleccione Send custom report by e-mail de la lista desplegable en Task. La interfaz es la misma para crear o editar una tarea (excepto el botón Create o Update para guardar).

Los campos comunes para cada tarea son:

  1. Scheduled: Periodicidad de la tarea, diariamente, mensualmente, etcétera o una sola vez (Not scheduled, ver siguiente punto).
  2. Next execution: Próxima ejecución de la tarea, seleccione fecha en el primer campo y hora en el segundo campo (menú emergente al hacer clic en cada uno).
  3. Group: Grupo al que pertenecerá la tarea.
  4. Report pending to be created: Entre los reportes registrados seleccione el que va a ser enviado.
  5. Send to e-mail addresses (separated by a comma): Destinatario(s).
  6. Report Type: Tipo de informe que será enviado (XML, etcétera).

Si se elecciona Send custom report (from template) by email en la lista Task se debe configurar, además:

  • Template pending to be created: Plantilla personalizada para creación del informe.
  • Agents: Agentes a incluir en el informe, utilice Regex agent filter para seleccionar agentes por medios de expresiones regulares.
  • Report per agent: Información de los Agentes seleccionados en Agents para el informe, si se desea generar informes separados para cada informe.

Para que funcione el envío del correo electrónico, se debe configurar previamente en las opciones de envío de Pandora FMS.

Plantillas de informes

Las plantillas de informes son componentes que permiten parametrizar la creación de informes que más tarde se podrán aplicar sobre un conjunto de agentes.

Cada elemento de las plantillas buscará la coincidencia con un agente y/o módulo mediante una expresión regular o una subcadena, haciendo muy flexible este sistema.

Al crear una plantilla de informe se define una serie de elementos. Estos elementos definidos, son los mismos ítems de informe que se definen para un informe.

La diferencia reside en que cada uno de estos ítems de plantilla generará uno o más ítems de informe, siempre y cuando al aplicar la plantilla exista una coincidencia con algún agente y/o módulo de los elegidos.

Crear plantilla

Acceda al menú OperationReportingCustom Reports y haga clic en el icono List of templates que está arriba a la derecha, justo al lado del icono List of reports. Haga clic en el botón Create template:

  • Group: Grupo al que pertenecerá la nueva plantilla.
  • Agents to apply: Una expresión regular, sin importar mayúsculas ni minúsculas, para filtrar los agentes a los cuales les será aplicada la nueva plantilla. Por ejemplo, si usa Network* los agentes llamados network_agent1 o NetworK CHECK concidirán cuando sea aplicada la plantilla.
  • Generate cover page in PDF render: Para generar una portada en PDF.
  • Generate index in PDF render: Para generar un índice en el renderizado o generación del PDF.

Para guardar la plantilla al terminar de rellenar los campos, pulse el botón Save.

Editor de items

Al pulsar el icono item editor se podrán crear nuevos ítems dentro de la plantilla.

Los tipos de ítems son los mismos que los de los informes, con la diferencia que, a la hora de aplicarse a un agente o módulo, este se buscará como una expresión regular. Por ejemplo, oracle_agent.* podrá corresponderse con los agentes: oracle_agent_1, oracle_agent_2, oracle_agent_producción, etcétera.

En caso de dejar vacío el campo, el ítem de la plantilla se aplicará sobre todos los agentes a la hora de aplicar la plantilla de informe.

Cuando se especifique un módulo, este podrá interpretarse de forma literal activando la casilla de verificación Module exact match. Si no se activa, utilizará el método estándar de coincidencia por expresión regular.

Lista de items

Menú OperationReportingCustom reports → icono List of templates → botón Edit de plantilla → icono List items.

En la sección de lista de ítems se pueden ver y editar los ítems creados dentro de la plantilla y modificar su orden además de borrarlos.

Opciones avanzadas de plantilla

Menú OperationReportingCustom reports → icono List of templates → botón Edit de plantilla → icono Advanced options.

En esta sección podrá configurar aspectos visuales del informe resultante como la fuente, el logotipo, la cabecera, la primera página o el pie de informe, tal como haría con un informe estándar.

Una vez haya terminado de editar los aspectos visuales, haga clic en el botón Update para guardar los cambios.

Gestión de plantillas

Menú OperationReportingCustom Reports y haga clic en el icono List of templates.

  • Desde allí podrá borrar una plantilla de informes por medio de su correspondiente icono de papelera en la columna Operations. También podrá seleccionar varias plantillas y luego pulsar el botón Delete.
  • De igual manera pulsando en el botón Duplicate de cada plantilla se podrá copiar con prefijo copy of más el nombre de la plantilla a una nueva plantilla.
  • Haciendo clic en el icono de lápiz correspondiente a cada ítem podrá editar la plantilla seleccionada.

Aplicación directa de una plantilla de informes

Menú OperationReportingCustom reports → icono List of templates. Luego en cada plantilla se dispone de botones para cada visualización: HTML, JSON, etcétera. Al hacer clic en uno de ellos se abrirá el formulario Generate a dynamic report el cual solamente traerá la consulta escrita en Agents to apply cuando se creó la plantilla.

  • En Filter group y Filter agent, de forma dinámica, se podrá filtrar de la lista presentada inicialmente en Agents available.
  • Haga clic en uno o varios de los agentes disponibles (o seleccione todos en Select all) y haga clic en el botón flecha derecha para agregar a la lista Agents to apply.
  • De manera inversa puede desmarcar agentes, utilice todos los campos y botones hasta lograr la lista de agentes necesitada.
  • Pulse el botón Generate.

Asistente de plantillas

Puede hacer uso del asistente de plantillas ( Template Wizard ) si se necesita instanciar una plantilla de informe en un informe real para tenerlo disponible en la lista de informes de Pandora FMS, por ejemplo:

Puede activar la casilla de verificación Create report per agent para generar un informe por cada agente seleccionado. Si no lo activa, se generará un informe general con toda la información.

  • En caso de que se genere un informe por agente el título del informe será de la forma: [título de la plantilla] - [nombre agente] ([nombre agente])
  • En caso de que se genere un informe total el título será de la forma: [título del informe] - agents ([número de agentes]) - [fecha]

Limpieza de informes

Para borrar los informes creados en aplicaciones anteriores de una plantilla vaya al Asistente de plantillas de informes.

Allí debe seleccionar una plantilla en la lista desplegable de Templates y luego hacer clic en el botón para borrar (botón de la escoba).

Esta acción eliminará todos los informes creados basados en esta plantilla, automáticamente.

Sistema ACL Enterprise enfocado a informes

Versión 771 o posterior.

Versión EnterprisePor medio del “Sistema ACL Enterprise” podrá crear perfiles personalizados con los que podrá asignar permisos de visualización, modificación, creación y borrado de informes.

Para ello deberá ir a la configuración del Sistema ACL Enterprise (ManagementProfilesEnterprise ACL setup), seleccionar el perfil al cual asignará los permisos en la lista desplegable en User profile.

Seleccione Reporting en Section y luego agregue en Section 2 los permisos que usted considere necesarios:

  • New custom reports: Permite crear informes al perfil de usuario seleccionado.
  • Edit custom reports: Permite editar informes al perfil de usuario seleccionado.
  • Remove custom reports: Permite borrar informes al perfil de usuario seleccionado.

Volver al Índice de Documentación Pandora FMS