Ação Log to Server

A ação Log to Server introduz nativamente a capacidade de registro para API Tasks. Essa ação permite que você crie logs personalizados e os encaminhe junto com os logs de tempo de execução de API Task para qualquer servidor de Gerenciamento de informações e eventos de segurança (SIEM) configurado na Control Room.

Visão geral

O Log to Server permite que você verifique os logs de tempo de execução de API Tasks encaminhando os logs para um servidor SIEM. Você também pode criar logs personalizados e encaminhá-los junto com os logs de tempo de execução. Antes, as API Tasks não permitiam o encaminhamento de logs devido a restrições na capacidade de manipulação de arquivos.

O encaminhamento dos logs para um servidor SIEM oferece uma maneira centralizada de verificar os dados de tempo de execução da automação e depurar quaisquer erros que possam ocorrer durante a execução da automação. Você pode aproveitar os recursos de relatórios e análise das ferramentas disponíveis no servidor SIEM para analisar e gerenciar os logs. Você também pode manter os logs no servidor, conforme os requisitos organizacionais para auditorias de conformidade e regulatórias.

Antes de usar a ação Log to Server em uma automação, certifique-se de configurar a integração para SIEM. Para mais informações sobre como configurar as configurações de integração do SIEM, consulte Configurar a integração com a SIEM.

O log personalizado encaminhado contém os seguintes parâmetros:
Parâmetro Descrição
logMessage a mensagem de log contém o cabeçalho do log para o conteúdo do log.
executionId O ID de execução da automação. O ID de execução aparece na URL quando você abre a página Atividade da automação.
logLevel O nível de log que você definiu ao configurar a ação.
sysLogSource A tag da fonte de dados que você definiu ao configurar a ação. Essa tag serve como identificador para os logs.
botName O nome que você inseriu ao criar a automação.
botId O ID do bot da automação. O ID do bot aparece no URL quando você abre o bot na área de trabalho do editor de bots.
logCreatedTime A hora em que você criou a automação. Essa entrada inclui a data e a hora.

Configurações

Nota:

A ação Registrar no servidor está disponível para Task Bot e API Task, permitindo que os desenvolvedores escrevam mensagens de log personalizadas diretamente em suas automações.

Você pode visualizar os logs de tempo de execução de automação com base no local de armazenamento configurado pelo administrador da Control Room. Por exemplo, se o administrador ativar o encaminhamento de logs para a Control Room, as mensagens de log personalizadas serão registradas e armazenadas no repositório da Control Room.

Para mais informações sobre como configurar o local padrão do servidor para armazenar logs de automação, consulte Gerenciar o local do servidor para armazenar os logs de automação - Cloud e Gerenciar o local do servidor para armazenar os logs de automação - On-Premises.

  • Texto para registrar: Insira um nome para o cabeçalho do log. O parâmetro logMessage exibe o cabeçalho do log. O comprimento máximo de texto permitido é de 1.024 caracteres.
  • Você pode exportar as informações configuradas das variáveis na automação usando a opção Variáveis para registro. A ação Log to Server oferece suporte a variáveis de string, número, data/hora e booleana. As variáveis e seus respectivos valores padrão também aparecem no parâmetro logMessage.

    Escolha uma das seguintes opções:

    • Por tipo: Use essa opção para registrar variáveis com base no tipo. Você pode registrar as variáveis individualmente ou juntas.
      Nota: Ao selecionar a opção Por tipo, também é possível registrar as variáveis que você criar posteriormente, após adicionar a action Registrar variáveis no arquivo.
    • Seleção personalizada: Use essa opção para selecionar e registrar as variáveis individualmente ou juntas.
  • Tag da fonte de dados (opcional): Adicione tags para identificar as entradas de registro. As tags permitem filtrar com facilidade os registros no servidor SIEM. A tag da fonte de dados aparece no parâmetro sysLogSource.
  • Nível de registro: Selecione um nível apropriado para as informações de registro com base nos requisitos. O nível de log aparece no parâmetro logLevel. Os seguintes níveis de registro estão disponíveis:
    • Emergência
    • Erro
    • Aviso
    • Informações
    • Depurar

Solução de problemas

A ação Log to Server está disponível apenas em API Tasks e não em Task Bots.

Para testar sua API Task que contém Log to Server, se você usar a opção Depurar disponível na página do editor de API Task, verá o seguinte erro: Erro inesperado ao implantar o bot. Esse erro ocorre devido ao destino incompatível do agente. Durante a depuração, a API Tasks é executada no executor de bots local, que procura por um agente de bot do Windows ou macOS. Considerando que o destino do agente para uma ação Log to Server é headless. Essa incompatibilidade ocorre devido à diferença no destino do agente.

Para testar sua automação, salve-a e execute-a usando a opção Executar tarefa de API disponível no menu de reticências na página do repositório Privado.