Linha RM

Atalhos

Páginas filhas
  • CONFIGURANDO O RM TRACKLOG

Versões comparadas

Versão antiga 25

changes.mady.by.user Carlos Diego Lopes Almeida

Gravado em

comparado com

Nova versão 26

changes.mady.by.user Cesar Henrique Silva Rodrigues_

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO

Índice

01. VISÃO GERAL

...

O RM TRACKLOG e é o motor de logs do RM , ele disponibiliza responsável por disponibilizar informações sobre o sistema através de arquivos de texto com contendo data e hora do evento , e mensagem criada mensagens criadas de forma automática.

Portanto, com o Tracklog TRACKLOG, os logs são capazes de mostrar o que, quando e onde aconteceu um evento, além de indicar quem deu início a ele.

1.1 O TRACKLOG REGISTRA

...

VÁRIOS NÍVEIS (LEVEL) DE LOG

OrdemNível (Level)Identificado no arquivoUso
0Verbose[VRB]Verbose é o nível mais ruidoso, raramente (ou nunca) habilitado para um aplicativo de produção.
1Debug[DBG]Debug é usado para eventos internos do sistema que não são necessariamente observáveis ​​de fora, mas são úteis para determinar como algo aconteceu.
2Information[INF]Os eventos de informação descrevem coisas que acontecem no sistema que correspondem às suas responsabilidades e funções. 
Geralmente estas são as ações observáveis ​​que o sistema pode realizar.
3Warning[WRN]Quando o serviço está degradado, em perigo ou pode estar se comportando fora de seus parâmetros esperados,
os eventos de nível de aviso são usados.
4Error[ERR]Quando a funcionalidade não está disponível ou as expectativas são quebradas, um evento de Erro é usado.
5Fatal[FTL]O nível mais crítico, os eventos fatais exigem atenção imediata.

...

1.2 INFORMAÇÕES CONTIDAS NO ARQUIVO DE LOG

O arquivo de log e é escrito conforme um template padrão (outputTemplate):

Bloco de código
"{SourceContext}{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} {Legacy} [{Level:u3}] {Message:lj} ({EnvironmentName}|{EnvironmentUserName}) <{ThreadId}:{ThreadName}>[{ProcessId}:{ProcessName}] [{CallerFilePath} - ({CallerLineNumber}) - {CallerMemberName}] [{Module}, {Category}, {Funcionality}] {NewLine}{Exception}"
Propriedades do templeteExemplo de dados logadoDescrição
{SourceContext}RM.Lib.Monitoring.Tracklog.Test.LogUnitTest

Contexto onde

encontra-se

o log

, geralmente

se encontra. Geralmente o namespace da classe que

esta

está usando o TrackLog.

{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} 2022-08-30 17:44:44.870 -03:00Data e hora do evento.
{Legacy} [LGC]Registros do sistema antigo de log são identificado com a tag [LGC]
[{Level:u3}] [INF]Level Nível (level) do evento.
{Tenant}shared-environmentIdentifica o Tenant do evento, esse . Esse item é acoplado a à mensagem.
{Message:lj} Information log testMensagem do evento.
({EnvironmentName}|{EnvironmentUserName}) (Production|BH01\carlos.almeida)Nome do ambiente e do usuário.
<{ThreadId}:{ThreadName}><13:Host>ThreadId e ThreadName do evento.
[{ProcessId}:{ProcessName}] [36956:Host.exe]ProcessId e ProcessName do evento.
[{CallerFilePath} - ({CallerLineNumber}) - {CallerMemberName}] [Lib\RM.Lib.Monitoring.Tracklog.TesteUnitario\LogUnitTest.cs - (114) - Should_Write_Info_Log]Arquivo de onde foi registrado o evento de log com numero o número da linha da e o método que o chamou.
[{Module}, {Category}, {Funcionality}] [RMLib, SmartClient, Configuracao]Modulo Módulo, categoria e funcionalidade do sistema onde o evento ocorreu.
{NewLine}{Exception}NullReferenceException: Write Error Log Exception ---> System.Exception: Should_Write_Error_LogWarning, Error e Fatal é registrado e uma nova linha com a exceção

02. COMO CONFIGURAR

...

Tracklog O TRACKLOG é configurado através de um do arquivo json: JSON appsettings.log.json que , o qual deve ficar dentro do no diretório raiz do sistema RM, caso . Caso o arquivo não seja encontrado, o sistema assume as configurações padrões. 

O conteúdo do arquivo de configuração é divido em algumas sessões, conforme detalhado a seguir. 

2.1 SESSÕES DO ARQUIVO DE CONFIGURAÇÃO

A principal é a sessão principal do arquivo de configuração é a "Serilog", onde é informado como e o sistema deve escrever o arquivo de log e os recursos que serão utilizados: 

...

PropriedadeDescrição
pathCaminho onde o arquivo de log vai ser salvo
  • Padrão: <Diretório Raiz da aplicação>\\Logs

Formato:

Os diretórios devem ser separados por duas barras invertidas \\ ou uma barra normal /
Exemplo:

"path": "C:\\TOTVS\\RM\\Logs\\" ✔️

"path": "C:/TOTVS/RM/Logs/" ✔️

"path": "C:\TOTVS\RM\Logs\" ❌

restrictedToMinimumLevelSomente mensagens de log deste nível ou acima são deste nível serão enviadas para este coletor.
  • Padrão: Information
formatProviderFornece informações de formatação específicas da cultura ou null.

Padrão: Null

outputTemplateUm modelo de mensagem descrevendo o formato usado para gravar no coletor. 
  • O padrão é "{SourceContext}{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} {Legacy} [{Level:u3}] {Message:lj} ({EnvironmentName}|{EnvironmentUserName}) <{ThreadId}:{ThreadName}>[{ProcessId}:{ProcessName}] [{CallerFilePath} - ({CallerLineNumber}) - {CallerMemberName}] [{Module}, {Category}, {Funcionality}] {NewLine}{Exception}".
fileSizeLimitBytesO tamanho máximo aproximado, em bytes, para o qual um arquivo de log poderá crescer.
Para crescimento irrestrito, passe null.
  • O padrão é 1073741824 (1 GB). Para evitar escrever eventos parciais, o último evento dentro do limite
será escrito na íntegra mesmo que exceda o limite.
bufferedIndica se a liberação para o arquivo de saída pode ser armazenada em buffer ou não.
  • O padrão é False.
sharedPermitir que o arquivo de log seja compartilhado por vários processos.
  • O padrão é False.
flushToDiskInterval

Se fornecido, uma limpeza completa do disco será executada periodicamente no intervalo especificado.
Deve ser maior ou igual a 0.
Formato: d.hh:mm:ss
d : numero de dias.
hh: numero de horas.
mm: numero de minuto.
ss: numero de segundos.

Exemplo: 

flushToDiskInterval: "2.00:00:00"
A limpeza completa do disco será executada a cada dois dias.

  • O padrão é Null.
rollingInterval

O intervalo no qual o registro será transferido para um novo arquivo.

RollingInterval
InfiniteO arquivo de log nunca rolará; nenhuma informação de período de tempo será anexada ao nome do arquivo de log.
YearRole todos os anos. Os nomes dos arquivos terão um ano de quatro dígitos anexado no padrão yyyy.
MonthRole a cada mês do calendário. Os nomes dos arquivos terão yyyyMM anexado.
DayRole todos os dias. Os nomes dos arquivos terão yyyyMMdd anexado.
HourRole a cada hora. Os nomes dos arquivos terão yyyyMMddHH anexado.
MinuteRole a cada minuto. Os nomes dos arquivos terão yyyyMMddHHmm anexado.
  • O padrão é Null.
rollOnFileSizeLimit

Se True, um novo arquivo será criado quando o limite de tamanho do arquivo for atingido.
Nomes de arquivo  terá um número anexado no formato _NNN, com o primeiro nome de arquivo sem número.

  • O padrão é False.
retainedFileCountLimitO número máximo de arquivos de log que serão retidos,
incluindo o arquivo de log atual. Para retenção ilimitada, passe null.
  • O padrão é 31.
encodingCodificação de caracteres usada para escrever o arquivo de texto.
Opções: UTF8, UTF7, UTF32, Unicode, BigEndianUnicode, ASCII, Default
  • O padrão é UTF8
retainedFileTimeLimit

O tempo máximo após o término de um intervalo em que um arquivo de log contínuo será retido.
Deve ser maior ou igual a 0.
Ignorado se rollingInterval for Infinite.
Formato: d.hh:mm:ss
d : numero de dias.
hh: numero de horas.
mm: numero de minuto.
ss: numero de segundos.

Exemplo: 

retainedFileTimeLimit: "6.14:32:15"
O arquivo será retido depois de 6 dias 14 horas e 32 minutos e 15 segundos.
Caso o valor informado esteja em um formato invalido esse parâmetro será ignorado pelo sistema.

  • O padrão é Null.

...

Dica
titleLembre-se

Para usar o arquivo após o download, renomeei renomeie-o para appsettings.log.json e o coloque dentro do diretório raiz diretório raiz do sistema RM.