Configurar o Contexto do coletor de eventos de MID Web Server

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 4 min. de leitura
  • Configure o Contexto do coletor de eventos do MID WebService para fornecer um método de URL para enviar mensagens de evento de uma origem externa para o MID Server.

    Antes de Iniciar

    Certifique-se de que o plug-in Gestão de eventos Connectors (sn_em_connector) esteja instalado na instância Now Platform.

    Função necessária: evt_mgmt_admin

    Por Que e Quando Desempenhar Esta Tarefa

    O formato padrão do URL para enviar mensagens de evento de uma origem externa para o MID Server é http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2. Este URL oferece bom desempenho.

    De uma origem externa, para enviar mensagens de evento que não estão no formato jsonv2, o formato do URL é: http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Name_of_Transform_Script}, em que a variável {Name_of_Transform_Script} é o nome completo do script e sempre começa com o texto: TransformEvents_.

    Por exemplo, assuma os seguintes valores:
    • {MID_Server_IP}: 10.118.69.27
    • {MID_Web_Server_Port}: 8097
    • Nome do script de transformação: EventsToProcess
    A URL a ser usada é, portanto: http://10.118.69.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess
    Nota:
    • O URL no formato http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name}também é compatível.
    • O formato de data para eventos é yyyy-Md h:mm:ss.

      Se você receber um evento cuja data esteja em um formato diferente, deverá usar um {transform_script_name} que seja apropriado para o formato de data do evento de entrada. Caso contrário, o evento não será processado corretamente.

      Por exemplo, se um evento chegar em 27 de junho de 2019 às 11h25 com uma data listada de 2019/06/27/ 11:25:00 a, use um {transform_script_name} com um formato de data de yyyy/MM/dd/ HH:mm:ss a para corresponder ao formato do evento recebido.

    Procedimento

    1. Navegar até Todos > Gestão de eventos > Integrações > Ouvinte de Evento de Serviço Web MID.
    2. Na lista Contextos do coletor de eventos do MID WebService, clique em Novo.
    3. No formulário, preencha os campos.
      Tabela 1. Formulário Contexto de coletores de eventos do MID WebService
      Campo Descrição
      Nome Um nome exclusivo para este coletor para facilitar a identificação.
      Descrição resumida Insira uma descrição resumida e significativa deste coletor.
      Extensão do Servidor Web MID Especifique e inicie a extensão do MID Web Server. Os métodos de autenticação compatíveis são listados no campo Tipo de autenticação da extensão do MID Web Server. Para obter informações sobre como configurar uma extensão do MID Web Server, consulte Configuração do MID Web Server.
      Status Este campo é preenchido automaticamente com o status da extensão do MID Web Server. Este campo ficará em branco até que a extensão do MID Web Server seja iniciada. Depois de emitir um comando para a extensão do MID Web Server, um dos seguintes valores é exibido:
      • Iniciado: o coletor está em execução.
      • Parado: o coletor não está em execução.
      • Off-line : o MID Server está inativo.
      • Erro: o coletor falhou com um erro (a mensagem de erro é exibida em Mensagem de erro).
      • Aviso: ocorreu uma exceção no tempo de execução.
      Executar nos(as) MID Serverespecífico ou Clusterde MID Server específico, conforme definido na extensão do MID Web Server especificada.
      MID Server O MID Serverespecífico ou o clusterde MID Server específico, conforme definido na extensão do MID Web Server especificada.
      Executando no(a) O nome do MID Server no qual a extensão do MID Web Server está sendo executada.
    4. Clique com o botão direito do mouse no título do formulário e clique em Salvar.
    5. Em Links relacionados, clique em Iniciar para iniciar o coletor.
      Tabela 2. Comandos no formulário de Contexto Gestão de eventos
      Link relacionado Descrição
      Iniciar Se não estiver em execução, inicie o coletor. Esta ação verifica se um endpoint de API de serviço web com a aplicação Gestão de eventos está em execução no MID Server.
      Parar Interrompe o coletor em execução no MID Serverconfigurado. Se o coletor não estiver em execução, nenhuma ação será realizada.
      Reiniciar Interrompe e inicia o coletor no MID Serverconfigurado.
      Atualizar parâmetros Envia parâmetros atualizados para o coletor. Os parâmetros também são atualizados quando a extensão de contexto Gestão de eventos MID Server é atualizada. Se você clicar neste controle quando o coletor não estiver em execução, nenhuma atualização será feita.

    Exemplo

    Mostrando o uso da URL para transformar mensagens de evento no formato JSON v2

    Suponha que as mensagens de evento no formato JSON v2 sejam enviadas para o MID Server. Ao usar o URL jsonv2, não há necessidade de usar uma inclusão de script.

    Tabela 3. Dados para o exemplo de JSON v2
    Campo Valor
    MID_Server_IP 10.218.64.27
    MID_Web_Server_Extension_Port 8097
    Formato da mensagem do evento jsonv2

    Substitua as variáveis no formato padrão da URL http://<my-instance> .service-now.com/api/global/em/jsonv2 com valores da tabela anterior:http://10.218.64.27:8097/api/global/em/jsonv2

    Exemplo que mostra o URL para enviar mensagens que não estão no formato jsonv2

    O formato da URL para enviar mensagens de evento de uma origem externa que não esteja no formato jsonv2 é http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event/Transform={Name_of_Transform_Script} em que {Name_of_Transform_Script} A variável é o nome completo do script e sempre começa com o texto: TransformEvents_. O nome do script deve ser especificado como o parâmetro do cabeçalho Transformação e sempre deve iniciar com o prefixo TransformEvents_.

    Para este exemplo, suponha que o nome do script seja EventsToProcess, portanto, o URL é:http://10.138.64.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess

    Exemplo mostrando mensagens de evento no formato JSON v2
    Nota:
    Ao copiar e colar o texto a seguir, caracteres ocultos também podem ser copiados e causar resultados inesperados.
    
    curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST --data "{
        "records":
        [ {
             \"source\" : \"Simulated\",
            \"node\" : \"nameofnode\",
            \"type\" : \"High Virtual Memory\",
            \"resource\" : \"C:\",
            \"severity\" : \"5\",
            \"description\" : \"Virtual memory usage exceeds 98%\",
            \"ci_type\":\"cmdb_ci_app_server_tomcat\",
            \"additional_info\":\"{\\\"name\\\":\\\"My Airlines\\\"}\"
          },
          {
          \"source\" : \"Simulated\",
          \"node\" : \"01.myairlines.com\",
          \"type\" : \"High CPU Utilization\",
          \"resource\" : \"D:\",
          \"severity\" : \"5\",
          \"description\" : \"CPU on 01.my.com at 60%\"
          }
       ]
    }" -u UserName:Password http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2