Configurar REST API integrações

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • Configure uma integraçãon para transmitir dados de log para sua instância ServiceNow no formato JSON para processamento por Análise de logs de integridade.

    Antes de Iniciar

    • Certifique-se de que a aplicação Análise de logs de integridade esteja instalada e provisionada em sua instância. Para obter mais informações, consulte Instalar Análise de logs de integridade (HLA).
    • Certifique-se de que uma instância de serviço esteja disponível.
    • Certifique-se de que o Análise de logs de integridade Mecanismo de IA esteja instalado e funcionando.
    • Certifique-se de que um MID Server esteja instalado e configurado com a capacidade de ingestão de log habilitada.

      Configuração do MID Server com capacidade de ingestão de log habilitada.

      Importante:
      Análise de logs de integridade não é compatível com IPv6. Para trabalhar com a aplicação, configure o MID Server para IPv4.
    • Certifique-se de que um MID Web Server esteja configurado para o MID Server.

      Para obter mais informações, consulte Configurar a extensão MID Web Server.

      No formulário Contexto do MID Web Server, no campo Executar em, selecione MID Server específico e não a opção de cluster. No campo MID Server, selecione o MID Server específico para o qual os dados de log são enviados.

    • Se o endereço IP do MID Server for exposto pela tradução de endereço de rede (NAT), um balanceador de carga ou um dispositivo semelhante, ele deverá ter um endereço IP público. Nas propriedades MID Server, adicione uma propriedade chamada mid.public_ip com o endereço IP público como o valor. Para obter mais informações, consulte Criar uma propriedade do MID Server.

    Função necessária: evt_mgmt_admin

    Procedimento

    1. Navegar até Espaços > Espaço de operações de serviços.
    2. No painel esquerdo, selecione o ícone do Launchpad de integrações ( ícone do Launchpad de integração)
    3. Na guia Procurar integrações, insira REST no campo de pesquisa.
    4. Selecione o bloco de integração de REST API.
      Nota:
      Se você iniciou o processo de integração sem atender a todos os pré-requisitos listados na seção Antes de começar, será exibida uma mensagem. Você tem a opção de cancelar a integração e concluir os requisitos ausentes ou continuar no modo de rascunho e preenchê-los mais tarde. Observe que você só pode ativar uma integração configurada quando todos os pré-requisitos forem atendidos. As integrações salvas que não foram ativadas estão disponíveis na guia Integrações instaladas em Integrations Launchpad, em Aguardando sua ação.
    5. Selecione Fornecer detalhes.
    6. No formulário, preencha os campos e selecione Avançar.
      Para obter uma descrição dos campos, consulte Campos de configuração de integração de REST API.
      Quando você seleciona Avançar, sua configuração é salva e a guia Instrução de configuração é exibida.
    7. Siga as instruções na tela para instalar a integração em sua ferramenta de monitoramento.
      1. Copie a URL fornecida.

        O URL tem o formato http://(MID_SERVER_IP):(MID_WEB_SERVER_PORT)/ap1/mid/hla/raw, em que /aps/mid/hla/raw é o endpoint.

      2. Cole o URL na configuração do console de terceiros em que você é solicitado a inserir o URL para logs de streaming para o MID Server.
      Nota:
      O método de autenticação usado para enviar logs na URL fornecida deve ser igual ao método definido no MID Web Server selecionado.
    8. Selecione Ativar para ativar a integração.
      A integração está ativada. Sua guia Visão geral é exibida.

    Resultado

    Log data começa a transmitir para sua instância ServiceNow. O bloco da integração está disponível na guia Integrações instaladas no Integrations Launchpad.

    Usuários com a função evt_mgmt_user podem usar Gestão de eventos para monitorar os logs e exibir os alertas que Análise de logs de integridade gera a partir deles.

    O que Fazer Depois

    Revise o status de streaming de dados de log e as origens de da integração na guia Visão geral. Aproveite as informações exibidas para refinar como HLA lê os dados de log ajustando sua configuração de integração. Para obter mais informações, consulte Revisar o status e as origens do fluxo de dados de log de uma integração [n.
    Nota:
    Na guia Visão geral, você pode acessar diretamente as páginas Mapeamento de entrada de dados, Estruturas de tipo de origem e Origens de log com o contexto desta integração selecionando o ícone do menu Exibir ( ícone do menu Exibir) e escolhendo a opção relevante. O menu também permite que você acesse diretamente o Visualizador de logs, que mostra os logs brutos que esta integração ingere.