Criando widgets por meio de uma origem de dados de API genérica

É possível usar a API Genérica para criar widgets que buscam dados de APIs do IBM® QRadar® e aplicativos QRadar com APIs expostas.

Antes de começar

Seu administrador deve configurar o QRadar Proxy para sua conta e é necessário um token de autenticação válido para que seja possível se conectar ao QRadar.

Sobre esta tarefa

As APIs retornam uma matriz JSON (quando há vários resultados) ou um objeto JSON (quando há apenas um resultado)... Os objetos JSON retornados são convertidas em uma matriz JSON que contém um elemento

Procedimento

  1. Clique em Configurar painel.

    A tela Configurar painel exibe uma biblioteca de widgets disponíveis, com detalhes sobre cada widget.

  2. Clique em Criar novo widget.
  3. Na página Novo Item do Painel , digite um nome e uma descrição para o widget.
  4. Selecione API genérica a partir da lista de origem de dados na seção Consulta , e digite um terminal de API, como um dos exemplos a seguir:
    • /app/qproxy/proxy/api/asset_model/assets
    • /app/qproxy/proxy/api/health_data/top_rules
    • /app/qproxy/proxy/api/config/deployment/hosts
    • /app/qproxy/proxy/api/config/event_sources/log_source_management/log_sources

    Para obter mais informações, consulte Dicas para criar consultas de API genérica para gráficos de painel.

  5. Opcional: Adicionar parâmetros à consulta da API Generic.
    1. Insira parâmetros existentes na instrução. Clique no ícone Inserir parâmetro e, em seguida, clique em Inserir para cada parâmetro relevante.
    2. Para alterar o valor padrão do parâmetro, clique no ícone Visualizar Parâmetros e clique em Salvar depois de configurar o valor padrão.
      Ao mudar o valor padrão de um parâmetro, ele é mudado em todos os lugares nos quais o parâmetro é usado em sua área de trabalho, exceto em painéis e widgets expandidos ou fixados. Se você não configurar o valor como padrão, a mudança atualizada se aplicará apenas à sessão atual. No entanto, se você configurar o valor como padrão, o valor da sessão atual também usará esse valor.

      O parâmetro SYSTEM:accountId predefinido retorna o ID da conta do usuário que está logado. Os parâmetros do sistema são do tipo somente leitura e não é possível mudar o valor padrão.

      Os parâmetros predefinidos SYSTEM:timerange:start e SYSTEM:timerange:end representam os tempos de início e de parada em milissegundos com base no valor da seleção de SYSTEM:timerange , como 'Últimos 30 minutos'. Esses parâmetros são usados para gráficos baseados em tempo que rastreiam casos Por exemplo, casos ao longo do tempo por tipo.. A API para esse tipo de gráfico de tempo pode ser semelhante ao exemplo a seguir:/api/respond/rest/orgs/{SYSTEM:accountId}/stats/csv/incidents_by_type_over_time?start_date={SYSTEM:timerange:start}&end_date={SYSTEM:timerange:end}

    3. Para adicionar um parâmetro em sua área de trabalho, clique em Adicionar, dê ao parâmetro um nome e valor padrão, se necessário, e em seguida, clique em Salvar.

      Após incluir parâmetros em um widget de um painel pela primeira vez, a placa Parâmetros aparece no painel. Quando você remove parâmetros do widget e nenhum outro widget nesse painel usa o parâmetro, a placa Parâmetros desaparece.

  6. Escolha um tempo de atualização para a frequência com que você pesquisa a origem de dados. O tempo de atualização padrão é a cada 5 minutos.. Quanto menor o tempo de atualização, maior o impacto no desempenho no IBM QRadar. O tempo de atualização é iniciado após a conclusão da consulta.
    Por exemplo, se a consulta levar três minutos para ser concluída, o tempo de atualização será iniciado somente após o término da execução de três minutos.
  7. Se o objeto raiz no JSON retornado não for a matriz que você deseja plotar, digite um Mapeamento de Resultados para definir qual chave contém os dados relevantes que deseja plotar. Para obter mais informações, consulte Dicas para criar consultas de API genéricas para gráficos de painel.
  8. Opcional: Se o JSON retornado incluir um mapeamento de título, configure Usar título a partir do conjunto de resultados para On. Para obter mais informações, consulte Dicas para criar consultas de API genéricas para gráficos de painel.
  9. Clique em Executar Consulta.
    Ao criar o widget pela primeira vez, não será possível configurar os gráficos se nenhum resultado de dados for retornado. Tente tornar os critérios nos campos menos rigorosos e execute a consulta novamente.
  10. Criar um gráfico de painel na seção Visualizações .
    Como é possível criar várias visualizações e gráficos por meio da mesma consulta, dê um nome exclusivo à visualização. Por padrão, o título e o status do gráfico na barra de título são exibidos; para ocultá-los, clique no ícone Mais opções e alterne as configurações para Desativado.
  11. Selecione um tipo de gráfico e configure as propriedades relevantes. Para obter casos de uso para ajudar a decidir qual tipo de gráfico usar, consulte Tipos de gráfico de widget.
    Tipo de gráfico Instruções
    Barra Criando um gráfico de barras
    Número Grande Criando um gráfico de número grande
    Geográfico Criando um gráfico geográfico
    Gráfico de pizza Criando um Gráfico de Setores Circulares
    Dispersão Criando um gráfico de dispersão
    Tabular Criando um gráfico tabular
    Séries temporais Criando um gráfico de série temporal
  12. Previsualizar como o gráfico se parece e, em seguida, clicar em Salvar.
    Dica: os rótulos para o gráfico têm como origem as consultas usadas. Se eles forem ininteligíveis no visualização, edite os rótulos na seção Visualizar.