Conectarse a una fuente ServiceNow de datos - Amazon Managed Grafana

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Conectarse a una fuente ServiceNow de datos

Esta es la fuente ServiceNow de datos que se utiliza para conectarse a ServiceNow las instancias.

nota

Este origen de datos es solo para Grafana Enterprise. Para obtener más información, consulte Administración del acceso a los complementos empresariales.

Además, en los espacios de trabajo compatibles con la versión 9 o posterior, es posible que se deba instalar el complemento adecuado para este origen de datos. Para obtener más información, consulte Ampliación de su espacio de trabajo con complementos.

Características

  • Consultas

    • Estadísticas de consultas de API

    • Consultas de API de tabla

      • Incidentes, cambios y cualquier otra tabla

  • Alertas

  • Anotaciones (característica beta)

  • Variables de plantilla

Configuración

Seleccione los orígenes de datos en el panel izquierdo de Grafana.

Seleccione Agregar origen de datos:

Ingrese servicenow para buscar el complemento de origen de datos:

Ingresa ServiceNow la URL:

Elija Guardar y probar. Deberías ver un mensaje verde con el texto «ServiceNow Conexión correcta».

Ejemplos de paneles

Los paneles prediseñados se incluyen con el complemento y se pueden importar a través de la página de configuración del origen de datos, en la pestaña Paneles.

Uso

Hay dos formas de devolver datos en el editor de consultas.

  • TableAPI

  • AggregateAPI

Actualmente, los usuarios pueden elegir entre consultar tablas predefinidas, como las siguientes:

  • Cambios

  • Incidentes

O bien, a partir de la v1.4.0, una lista de tablas y campos basada en una API con la opción Otros (tabla personalizada). Esta opción le permitirá consultar los datos de cualquier tabla disponible para el usuario que haya utilizado para configurar la fuente de ServiceNow datos.

La opción Tabla personalizada debe admitir exactamente las mismas características que las listas de tablas predefinidas.

Consultas de TableAPI

TableAPI devuelve datos adecuados para mostrarlos en un panel de tabla. Permite mostrar una selección ordenada de campos, además de opciones de filtro. El editor de consultas también proporciona un campo para limitar el número de filas que devuelve una consulta.

Ejemplo de panel de tabla que muestra resultados de la consulta anterior.

Mostrar

La fila Mostrar proporciona un selector para mostrar un campo. También se pueden especificar varios campos. Los campos se devolverán en el orden exacto especificado.

Valores de visualización

El indicador Valores de visualización hará que la consulta devuelva valores aptos para el usuario, o valores de visualización, en lugar de valores numéricos.

Por ejemplo, una gravedad de nivel 1 sin este indicador solo mostraría 1. Si el indicador está habilitado, se mostrará el valor 1 - High.

Según la documentación de la ServiceNow API, esto puede tener un impacto negativo en el rendimiento.

nota

[…] especificar el valor de visualización puede provocar problemas de rendimiento, ya que no se lee directamente de la base de datos y podría incluir una referencia a otros campos y registros.

Filtros (generales)

La fila Filtros permite reducir las filas mostradas en función de varios criterios de campo y valor.

Todos los filtros se combinan con una operación AND u OR.

Los siguientes campos están disponibles cuando no se utiliza una tabla personalizada (esta lista se ampliará en el futuro).

Active Asset Group Assigned To Escalation Issue Number Description Priority State Type Change Risk Change State Start Date End Date On Hold

Al seleccionar una tabla personalizada, los campos se rellenan automáticamente desde la API de ServiceNow.

Filtros de fecha
Campo de tiempo Operadores Valor
Abierto a las Hoy o antes de hoy, hoy no, antes, a las o antes, después, a las o después timestamp javascript:gs.daysAgo(30)
Fecha límite de actividad
Cerrado a las
Fecha de vencimiento
Inicio esperado
Hora de reapertura
Resuelto a las
Fin del trabajo
Inicio del trabajo
Omitir tiempo

Para obtener valores de fecha adicionales, consulte: https://developer.servicenow.com/app.do#!/ api_doc? v=NewYork&id=r_sgsys-dategenerate_s_s

Operadores (generales, basados en cadenas)
  • Empieza por

  • Ends With (Acaba en)

  • Como

  • No como

  • Igual a

  • No igual a

  • Is Empty (Está vacío)

Operadores (basados en tiempo)
  • Hoy

  • Hoy no

  • Antes

  • A las o antes

  • Después

  • A las o después

Valores

La selección del valor depende del tipo de filtro seleccionado.

  • Los filtros booleanos tienen las opciones Verdadero/Falso

  • Los filtros de texto permiten escribir cualquier valor

  • Escalación: la prioridad tiene un conjunto fijo de valores numéricos

Ordenar por

La fila Ordenar por permite reducir las filas mostradas en función de varios criterios de campo y valor.

Todos los filtros se combinan con una operación AND. Se agregará compatibilidad para operadores adicionales.

Límite

Se puede especificar un límite de filas para evitar que se devuelvan demasiados datos. El valor predeterminado es 25.

Campo de tiempo

Time Field es lo que convierte los datos consultados en una serie temporal. El hecho de que sus datos se traten como series temporales significa que no se mostrarán los valores del “campo de tiempo” seleccionado que no se encuentren dentro del intervalo de tiempo del panel.

El campo de tiempo predeterminado que se utiliza es “Abierto a las”, pero se puede cambiar por cualquier campo disponible que contenga un valor de tiempo.

Se proporciona un valor especial “Omitir tiempo” para permitir obtener resultados “hasta ahora” y también para permitir que los filtros controlen los datos que se muestran.

Consultas de AggregateAPI (estadísticas)

AggregateAPI siempre devolverá métricas con las siguientes agregaciones: avg, min, max y sum. El filtrado también está disponible para restringir las consultas.

Mostrar

La fila Mostrar proporciona un selector para mostrar una métrica. También se pueden especificar varias métricas.

Filtros (generales)

Los filtros de agregación permiten reducir las métricas mostradas en función de criterios de campo y valor, de forma similar a la opción de tabla.

Todos los filtros se combinan con una operación AND. Se agregará compatibilidad para operadores adicionales.

Las opciones de filtro de estadísticas son las mismas que las de TableAPI.

Agregación

Hay cuatro tipos de agregaciones de métricas, además de un “recuento”:

  • Media

  • Mínimo

  • Máximo

  • Sum

  • Recuento: devuelve el “número” de métricas devueltas por una consulta

Agrupación por

Este selector permite dividir las métricas en agregaciones menores. Al agrupar por “prioridad”, se obtendrían las métricas con una “etiqueta” de prioridad y los valores únicos separados.

Plantillas

En lugar de codificar los nombres en las consultas, puede utilizar variables. Las variables se muestran como cuadros de selección desplegables en la parte superior del panel de control. Puede usar estos cuadros desplegables para cambiar los datos que se muestran en su panel.

Consulte el ejemplo de la sección Variable de consulta sobre cómo agregar una variable de consulta y hacer referencia a ella con un valor de plantilla.

Variable de consulta

Si agrega una variable de plantilla de tipo Query, puede escribir una consulta que devuelva elementos como nombres de categorías, nombres de clave o valores de clave que se muestran en un cuadro de selección desplegable.

Por ejemplo, puede tener una variable que contenga todos los valores de categories especificando una consulta como esta en la configuración de consulta de la variable de plantilla.

Al elegir la configuración de consulta, se muestra una sección de filtro que le permite elegir un tipo y un campo. Actualmente, el tipo está limitado a incidentes y cambios. Al seleccionar un tipo, se le proporciona una lista de los campos aplicables a ese tipo. Una vez seleccionados un tipo y un campo, se mostrará una vista previa de los valores en la parte inferior con las opciones disponibles para ese tipo o campo. Estos valores se mostrarán en una lista desplegable en el panel, que puede utilizar junto con las plantillas para filtrar los datos de los paneles de dicho panel.

Por ejemplo, si agrega una variable denominada categoría y, a continuación, selecciona Tipo = Incidentes y Campo = Categoría, verá una lista de opciones para el valor Categoría. Si, a continuación, agrega un filtro a un panel y selecciona Categoría igual a ${category}, los datos del panel solo mostrarán los datos de la categoría seleccionada en la lista desplegable del panel.

Importe el panel Incidentes por categoría para ver un ejemplo.

Uso de variables en consultas

Existen dos sintaxis:

Ejemplo de $<varname> con una variable de plantilla llamada hostname:

Ejemplo de [[varname]] con una variable de plantilla llamada hostname:

Alertas

Se admiten las alertas estándar de Grafana. Cualquier consulta definida en un panel de gráfico se puede utilizar para generar alertas.

A continuación se muestra un ejemplo de consulta y una alerta. Esta consulta devolverá un gráfico de todos los incidentes críticos de alta prioridad que están abiertos:

Esta alerta se iniciará cuando haya más de cinco incidentes críticos de alta prioridad abiertos:

Al probar la regla de alerta, se mostrará el resultado de esta regla y, al seleccionar el historial de estados, se mostrará la alerta pasando de “correcto” a “pendiente” y luego a “alerta”.

En la vista de gráfico se mostrará una línea vertical y el icono del corazón en la parte superior se volverá naranja mientras la alerta esté pendiente.

Una vez que se cumplen los criterios de alerta, la regla pasa a ser roja.

En la vista de gráfico, aparecerá la línea vertical roja y el icono del corazón en la parte superior se volverá rojo.

Escritura de incidentes para las alertas

Característica beta

  • Configure un canal de notificación para su fuente de datos. ServiceNow

Esto configurará un canal de notificaciones de Grafana que utilizará el usuario configurado para crear incidentes en la ServiceNow instancia de esta fuente de datos.

Esta acción requiere que el usuario de la fuente de ServiceNow datos tenga permisos para escribir incidentes.

Uso de un proxy HTTP

Cuando utilice un proxy HTTP, Amazon Managed Grafana necesitará establecer las siguientes variables de entorno en la ubicación del proxy:

  • HTTP_PROXY (o http_proxy)

    • Ruta completa: http://host:port

    • o simplemente: host:port

  • HTTPS_PROXY (o https_proxy):

    • Ruta completa: https://host:port

    • o simplemente: host:port

Anotaciones

Las anotaciones de Grafana son una característica beta a partir de la v1.4.0 de este origen de datos. Las anotaciones le permiten superponer eventos en gráficos.

La consulta de anotaciones admite las mismas opciones que el editor de consultas estándar, con algunas pequeñas diferencias:

  • Solo se puede seleccionar una columna “Mostrar”. Es probable que esto se solucione en una futura mejora.

  • El campo de tiempo es obligatorio.

Preguntas frecuentes

¿Qué sucede si no tenemos el complemento de roles de ITSM?

Se requiere acceso de administrador para llevar a cabo las siguientes acciones

Opción 1: Otorgue permisos de administrador de usuarios de Grafana para permitir el acceso a todas las tablas.

Opción 2: Cree un rol y aplíquelo ACLs a todas las tablas a las que Grafana deba acceder.

Se requiere acceso de administrador para llevar a cabo las siguientes acciones.

  1. El administrador que ha iniciado sesión debe aumentar el acceso a security_admin.

    1. En el panel de navegación superior derecho, elija el icono del perfil. El icono del perfil tiene un indicador desplegable en forma de cursor.

    2. En la lista desplegable, elija Elevar roles.

    3. En el modal que se muestra, seleccione la casilla de verificación security_admin.

    4. Seleccione OK.

  2. Cree un nuevo rol con la convención de nomenclatura que desee.

    1. Vaya a la sección de roles en la barra de navegación de la izquierda Seguridad del sistema => Usuarios y grupos => Roles

    2. Seleccione la opción Nuevo en la parte superior.

    3. Ingrese un nombre y una descripción pertinente para el rol.

    4. Seleccione Submit (Enviar).

  3. Cree un nuevo usuario o modifique un usuario existente con los roles necesarios.

    1. El rol que creó en el paso 2.

    2. personalize_dictionary

    3. personalize_choices

    4. cmdb_read (esto otorgará acceso de lectura a todas las tablas de cmdb)

  4. Cree una tabla ACLs para las tablas y los campos necesarios.

    1. Cree una ACL para la tabla sys_db_object.

      1. En la segunda columna del encabezado de búsqueda Nombre, ingrese sys_db_object y pulse Entrar.

      2. El resultado filtrado debería mostrar Tabla. Elija Tabla para navegar por el registro.

      3. En la sección de pestañas, seleccione Controles.

      4. En la parte inferior de la página, asegúrese de que Controles de acceso sea la pestaña seleccionada.

      5. Elija Nuevo para crear una nueva ACL.

      6. Cambie la selección de operación a lectura.

      7. En la sección Requiere rol, situada en la parte inferior de la pantalla, seleccione (haga doble clic) Insertar nueva fila y busque el rol que ha creado.

      8. Tras seleccionar el rol que creó, seleccione la marca de verificación verde.

      9. Elija Enviar en la parte inferior de la pantalla para crear la ACL y, a continuación, elija Continuar cuando aparezca el modal.

  5. Cree campos ACLs sys_db_object específicos. Se deben repetir los siguientes pasos para cada uno de los campos siguientes: Nombre, Etiqueta, Nombre para mostrar y Tabla de extensiones.

    1. Mientras esté en la vista de registros de tabla de sys_db_object, seleccione la pestaña Columnas en el grupo de pestañas más cercano a la parte superior de la pantalla.

    2. Localice el nombre del campo y selecciónelo.

    3. En la sección de pestañas inferior, elija Nuevo en la pestaña Controles de acceso.

    4. Cambie la operación a lectura.

    5. Seleccione (haga doble clic) el texto para insertar una fila en la parte inferior de la tabla “Requiere rol”.

    6. Busque el rol que creó y seleccione la casilla de selección verde.

    7. Seleccione Submit (Enviar).

    8. Asegúrese de haber repetido estos pasos para todos los campos obligatorios: Nombre, Etiqueta, Nombre para mostrar y Tabla de extensiones.

  6. Repita los pasos a partir del 4.1 en Cambios, Incidentes y cualquier otra tabla que no sea de CMDB y que desee consultar desde Grafana. No repita los pasos a partir del 4.2; ese paso solo es necesario para sys_db_object.