Configuração da ação Registrar no servidor em uma Tarefa de API

Utilize a ação Registrar no servidor para encaminhar os logs de tempo de execução e personalizados para um servidor SIEM externo, garantindo monitoramento centralizado e conformidade. Você pode adicionar os cabeçalhos, os níveis de registro e as tags de fonte de dados necessários ao log personalizado.

Neste exemplo, configure uma ação Registrar no servidor para encaminhar os logs de execução e as variáveis para um endpoint HTTP do Pipedream ao recuperar detalhes de um registro de Incidente do ServiceNow.

Pré-requisitos

Certifique-se de que as seguintes condições sejam atendidas:
  • Permissões para criar e executar Tarefas de API.
  • Permissões para configurar o servidor SIEM.
  • Conexões OAuth ativas para a instância do ServiceNow. Para mais informações sobre como configurar uma conexão OAuth do ServiceNow, consulte Criar a conexão de OAuth.
  • Uma conta Pipedream com uma fonte chamada Registro. No portal Pipedream, vá para Fontes > HTTP/Webhook > Novas solicitações para criar uma fonte. Quando você cria uma fonte, o portal cria um endpoint HTTP personalizado. Use este endpoint como o servidor SIEM para coletar os logs.

Procedimento

  1. Faça login em sua Control Room.
  2. Execute as seguintes ações para adicionar o endpoint HTTP Pipedream como o servidor SIEM para registro de logs.
    1. Vá para Administração > Configurações > Configuração de integração com SIEM.
    2. Selecione Ativado na Configuração de integração com SIEM externo.
    3. Insira o endpoint HTTP do Pipedream em Endpoint do servidor SIEM.
      O endpoint HTTP do Pipedream está no seguinte formato https://<unique_source_id>.m.pipedream.net. O portal Pipedream gera automaticamente o unique_source_id quando você cria uma fonte.
    4. Selecione POST como o método de requisição HTTP em Método HTTP.
    5. Insira mensagem como o atributo de evento para o arquivo JSON em Atributo de evento.
    6. Clique em Salvar alterações para salvar a configuração.
  3. Execute as seguintes etapas para criar uma Tarefa de API.
    1. Acesse Automação > Criar > Tarefa de API para criar uma Tarefa de API na página Automação.
    2. Digite servicenow-logging no campo de nome do modal Criar tarefa de API e, em seguida, clique em Criar e editar.
      A Tarefa de API com o nome logging aparece na página do editor.
  4. Execute as seguintes etapas para adicionar e configurar a ação Autenticação do ServiceNow.
    1. Vá para ServiceNow > Autenticação para adicionar a ação.
    2. Selecione Conexão OAuth da Control Room em Tipo de autenticação.
    3. Clique em Escolher para selecionar a conexão OAuth do ServiceNow configurada.
    4. Opcional: Digite um nome personalizado em Nome de sessão.
      Por padrão, Padrão é definido como o nome da sessão.
  5. Execute as etapas a seguir para adicionar e configurar a ação Obter registro do ServiceNow.
    1. Acesse ServiceNow > Obter registro para adicionar a ação.
    2. Insira incidente em Nome da tabela.
    3. Insira o sys_id do registro do incidente em sys_id do registro.
    4. Selecione Múltiplas variáveis e adicione as seguintes variáveis em Atribuir saída a uma variável de dicionário.
      • incident_state: Variável de string com a chave state para capturar o estado do registro.
      • incident_short_description: Variável de string com a chave short_description para capturar a descrição breve do registro.
      • incident_sys_id: Variável de string com a chave sys_id para capturar o sys_id do incidente.
  6. Execute as seguintes etapas para adicionar e configurar a ação Registrar no servidor.
    1. Vá para Ações > Registros e adicione a ação Registrar no servidor à automação.
    2. Digite logs de incidente do servicenow no campo Texto para registrar para definir o cabeçalho do conteúdo do registro.
    3. Selecione a guia Seleção personalizada na configuração Variáveis para registrar (opcional).
    4. Habilite as variáveis criadas na etapa anterior.
      A ativação das caixas de seleção encaminha as variáveis de string e seus valores para o endpoint.
    5. Digite incident_record no campo Tag da fonte de dados (Opcional) para definir o identificador exclusivo para o conteúdo do log no servidor.
      Usar tags permite filtrar com facilidade os registros. Você também pode usar uma variável de string para adicionar uma tag ao conteúdo do registro.
    6. Selecione Info (6) para definir o nível de registro.
  7. Selecione Salvar para salvar a automação.
Ao executar a automação utilizando a opção Executar tarefa de API > Executar agora no menu de reticências verticais na página Repositório, a automação recupera os detalhes do registro de incidente do ServiceNow e encaminha todos os logs de execução e personalizados para o endpoint HTTP do Pipedream.

Próximas etapas

Faça login no portal do Pipedream e vá para Fontes > Registros > Eventos para visualizar os logs. A entrada final do log contém os logs personalizados que a ação Registrar no servidor gera. O sistema encaminha os logs personalizados para o endpoint HTTP no seguinte formato:
{
  "method": "POST",
  "path": "/",
  "query": {},
  "client_ip": "35.155.28.36",
  "url": "https://04038b46964107d148cfdd251d89c826.m.pipedream.net/",
  "headers": {
    "host": "04038b46964107d148cfdd251d89c826.m.pipedream.net",
    "content-length": "459",
    "accept-encoding": "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
    "accept": "*/*",
    "user-agent": "Ruby",
    "content-type": "application/x-ndjson"
  },
  "bodyRaw": "{\"logMessage\":{\"logContent\":\"servicenow incident logs\",\"variableValues\":{\"incident_state\":\"1\",\"incident_sys_id\":\"57af7aec73d423002728660c4cf6a71c\",\"incident_short_description\":\"API call issue\"}},\"executionId\":\"b2e45a6d-186b-4b96-a2a2-3509808909f9_88f3a7ff9e646cc7\",\"logLevel\":\"INFO\",\"sysLogSource\":\"incident_record\",\"botName\":\"servicenow-logging\",\"botId\":\"45\",\"logCreatedTime\":\"2025-10-24T18:13:41.267798Z\",\"_tenantId\":\"dc170ff6-42d0-4f3d-8e9f-1904278d77f8\"}\n",
  "body": {
    "logMessage": {
      "logContent": "servicenow incident logs",
      "variableValues": {
        "incident_state": "1",
        "incident_sys_id": "57af7aec73d423002728660c4cf6a71c",
        "incident_short_description": "API call issue"
      }
    },
    "executionId": "b2e45a6d-186b-4b96-a2a2-3509808909f9_88f3a7ff9e646cc7",
    "logLevel": "INFO",
    "sysLogSource": "incident_record",
    "botName": "servicenow-logging",
    "botId": "45",
    "logCreatedTime": "2025-10-24T18:13:41.267798Z",
    "_tenantId": "dc170ff6-42d0-4f3d-8e9f-1904278d77f8"
  }
}