Creación de widgets a partir de un origen de datos de API genérica

Puede utilizar la API genérica para crear widgets que captan datos de las API de IBM® QRadar® y las aplicaciones QRadar con las API expuestas.

Acerca de esta tarea

Las API devuelven una matriz JSON (cuando hay varios resultados) o un objeto JSON (cuando sólo hay un resultado). Los objetos JSON devueltos se convierten en una matriz JSON que contiene un elemento.

Procedimiento

  1. Haga clic en Configurar el panel.

    La pantalla Configurar panel de control muestra una biblioteca de widgets disponibles, con detalles sobre cada widget.

  2. Haga clic en Crear widget nuevo.
  3. En la página Elemento de panel de instrumentos , especifique un nombre y una descripción para el widget.
  4. Seleccione API genérica en la lista de orígenes de datos en la sección Consulta y especifique un punto final de API, como por ejemplo uno de los siguientes ejemplos:
    • /api/asset_model/assets
    • /api/health_data/top_rules
    • /api/config/deployment/hosts
    • /api/config/event_sources/log_source_management/log_sources
    • /console/plugins/<QDI_appId>/app_proxy/comp_status_feed?timediff=471 (especifique data en Correlación de resultados).
      Nota: La URL puede cambiar entre versiones de QDI.

    Para obtener más información, consulte Sugerencias para crear consultas de API genérica para gráficos de panel de control.

  5. Opcional: Añada parámetros a la consulta de API genérica.
    1. Inserte los parámetros existente en la sentencia. Pulse el icono Insertar parámetro y, a continuación, pulse Insertar para cada parámetro relevante.
    2. Para cambiar el valor predeterminado del parámetro, pulse el icono Ver parámetros y pulse Guardar después de establecer el valor predeterminado.
      Cuando cambia el valor predeterminado para un parámetro, está cambiado el valor en todos los puntos donde se utiliza el parámetro en el espacio de trabajo, excepto en paneles de control ampliados o marcados. Si no establece el valor como valor predeterminado, el cambio actualizado solo se aplica a la sesión actual. Sin embargo, si establece el valor como valor predeterminado, el valor de la sesión actual también utiliza dicho valor.

      El parámetro SYSTEM:username predefinido devuelve el nombre de usuario del usuario que ha iniciado la sesión. Los parámetros del sistema son de solo lectura y no puede modificar el valor predeterminado.

    3. Para añadir un parámetro al espacio de trabajo, pulse Añadir, proporcione al parámetro un nombre y valor predeterminado, si es necesario, y pulse Guardar.

      Después de añadir parámetros a un widget en un panel de control por primera vez, la tarjeta Parámetros aparece en el panel de control. Si elimina parámetros del widget, y ningún otro widget de ese panel de control utiliza el parámetro, la tarjeta Parámetros desaparece.

  6. Elija un tiempo de renovación que indique la frecuencia con la que desea sondear el origen de datos. El tiempo de renovación predeterminado es cada 5 minutos. Cuanto más corto sea el tiempo de renovación, mayor será el impacto en el rendimiento en IBM QRadar. El tiempo de renovación comienza después de que se complete la consulta.
    Por ejemplo, si la consulta tarda 3 minutos en completarse, el tiempo de renovación comienza después de la ejecución de 3 minutos.
  7. Si el objeto raíz del JSON devuelto no es la matriz que desea trazar, entre un Correlación de resultados para definir qué clave contiene los datos relevantes que desea trazar. Para obtener más información, consulte Sugerencias para crear consultas de API genéricas para gráficos de panel de control.
  8. Opcional: Si el JSON devuelto incluye una correlación de título, establezca Utilizar título del conjunto de resultados en En. Para obtener más información, consulte Sugerencias para crear consultas de API genéricas para gráficos de panel de control.
  9. Haga clic en Ejecutar consulta.
    Cuando crea por primera vez el widget, no puede configurar los gráficos si no se devuelven resultados de datos. Intente conseguir que los criterios de los campos sean menos estrictos y vuelva a ejecutar la consulta.
  10. Cree un gráfico de panel de control en la sección Vistas .
    Puesto que puede crear varias vistas y gráficos desde la misma consulta, asigne a la vista un nombre exclusivo. De forma predeterminada, se visualiza el título y el estado del gráfico en la barra de título; para ocultarlos, pulse el icono Más opciones y cambie los valores a Desactivado.
  11. Seleccione un tipo de gráfico y configure las propiedades relevantes. Para ver los casos de uso que le ayudarán a decidir qué tipo de gráfico utilizar, consulte Tipos de gráfico de widget.
    Tipo de gráfico Instrucciones
    Barra Creación de un gráfico de barras
    Número grande Creación de un gráfico de números grandes
    Geográfico Creación de un gráfico geográfico
    Circular Creación de un gráfico circular
    Dispersar Creación de un gráfico de dispersión
    Tabular Creación de un gráfico de tabla
    Serie temporal Creación de un gráfico de serie temporal
  12. Obtenga una vista previa de cómo se ve el gráfico y luego pulse Guardar.
    Sugerencia: Las etiquetas del gráfico proceden de las consultas que se utilizan. Si son ininteligibles en la vista previa, edite las etiquetas en la sección Vista.