V10 RecursosReferência
RecursosReferência
Referência
Voltar | Lista de artigos

Como efetuar logging no ERP?

Última alteração a 29/09/2021

Obter informações sobre as operações efetuadas pelo utilizador é muito importante para qualquer aplicação transacional. É através deste registo que conseguimos despistar eventuais problemas, erros ou até mesmo perceber o que está a acontecer quando o código é executado.

O mecanismo de registo de log do ERP foi amplamente melhorado para dar mais informação ao utilizador e para que esta informação possa ser carregada para Excel.

Este mecanismo encontra-se na assembly Primavera.Platform.Helpers, que deve referenciar nos seus projetos em que pretende utilizar esta funcionalidade.

Os métodos disponíveis pertencem à classe StdLoggingHandler e são os seguintes:

ActivateLogAtiva o registo de log do ERP sem ser necessário reiniciar a aplicação
DeactivateLogDesliga o registo de log para a sessão atual do ERP
ClearLogFileLimpa o ficheiro de log em runtime
FileTraceRegista uma mensagem definida pelo programador
FileTraceEnterMethodRegista a entrada no método de invocação (com ou sem mensagem)
FileTraceExitMethodRegista a saída no método de invocação (com ou sem mensagem)
FileTraceFirstChanceExceptionRegisto colocado no handler de First Change Exception do ERP
FileTraceIgnoredExceptionRegista exceções ignoradas
FileTraceOnlyOnVerboseApenas faz registos de log se o modo verbose estiver ativo
FileTraceVerboseFaz um registo com mais detalhes da stack de invocação
FileTraceWithThrowRegista exceções que fazem throw
FullMessageFromExceptionRegista a mensagem total de uma excepção (incluindo inner exceptions)
GetActiveLogContentPermite visualizar os registos do log
GetActiveLogTailPermite visualizar os últimos n registos do log
GetActiveLogFileDevolve o nome do ficheiro de log ativo
IndentIndenta (adiciona uma tabulação inicial) as chamadas seguintes no log
OutdentRemove o espaçamento inicial

FileTraceIgnoredException vs FileTraceWithThrow

O método FileTraceIgnoredException deve ser usado para registar no log exceções que vão ser ignoradas. É possível identificar estes registos através da tag [IGNORED]. De forma semelhante, o método FileTraceWithThrow deve ser usado quando as exceções não vão ser ignoradas e vão ser devolvidas ao método anterior. Neste caso, o registo de log é gerado com a tag [THROWED].

FileTraceEnterMethod vs FileTraceExitMethod

O método FileTraceEnterMethod deve ser usado no início da execução de um método (ou função) para registar a sua entrada. As entradas de log seguintes são indentadas no ficheiro, voltando ao normal depois de invocar o método FileTraceExitMethod.

ActivateLog vs DeactivateLog

Quando o mecanismo de registo de log é ativado, é criado um ficheiro com o nome erp.log na pasta c:\temp. Quando este mecanismo é desativado, o ficheiro é removido. Este ficheiro também pode ser criado manualmente nesta pasta, o que faz com que o mecanismo seja automaticamente ativado no arranque de cada sessão do ERP.
Para o registo de log funcionar em modo verbose, o nome do ficheiro deve ser erp.verbose.log.

Pode encontrar vários exemplos de utilização destes métodos neste projeto do GitHub.

Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.

login para deixar a sua opinião.

Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
Características das entidades e serviços Conceito de integração Conceito de extensibilidade Como registar projetos de extensibilidade? Boas práticas de organização de projetos de integração