Histórico da Página

...

"WriteTo": [
{
"Name": "Async",
"Args": {
"configure": [
{
"Name": "MapToFile",
"Args": {

Propriedade

Descrição

enable

A propriedade "enable" tem como objetivo desabilitar o recurso de escrita de log em arquivo. Por padrão, o valor dessa propriedade é definido como "false", indicando que o recurso está desativado.

Padrão: false

path

Caminho onde o arquivo de log vai ser salvo

Padrão: <Diretório Raiz da aplicação>\\Logs
Aviso
title Atenção
O usuário do Sistema Operacional que está executando a aplicação precisa ter permissão de gravação no diretório especificado na propriedade "path".

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\" ❌

restrictedToMinimumLevel

Somente mensagens de log deste nível ou acima deste nível serão enviadas para este coletor.

Padrão: Information

formatProvider

Fornece informações de formatação específicas da cultura ou null.

Padrão: Null

outputTemplate

Um 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}".

fileSizeLimitBytes

O 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.

buffered

Indica se a liberação para o arquivo de saída pode ser armazenada em buffer ou não.

O padrão é False.

shared

Permitir 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
Infinite	O arquivo de log nunca rolará; nenhuma informação de período de tempo será anexada ao nome do arquivo de log.
Year	Role todos os anos. Os nomes dos arquivos terão um ano de quatro dígitos anexado no padrão yyyy.
Month	Role a cada mês do calendário. Os nomes dos arquivos terão yyyyMM anexado.
Day	Role todos os dias. Os nomes dos arquivos terão yyyyMMdd anexado.
Hour	Role a cada hora. Os nomes dos arquivos terão yyyyMMddHH anexado.
Minute	Role 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.

retainedFileCountLimit

O 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.

encoding

Codificaçã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.

...

Informações

icon	false
title	Arquivo Padrão

Download: default-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],
    		"MinimumLevel": "VerboseInformation",
    		"WriteTo": [
      {
        			{
				"Name": "SeqConsole",
        				"Args": { 
					"serverUrltheme": "http://localhost:5341" 
				}
      },
	  {
		  "Name": "Console",
		  "Args": {
			"theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
			Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
					"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} {Legacy} [{Level:u3}] {Message:lj} {EnvironmentUserName} {EnvironmentName}- <{ThreadId}>{NewLine}{ExceptionDetails}"
		  		}
		  	},
      {
        			{
				"Name": "Async",
        				"Args": {
          					"configure": [
            {
              						{
							"Name": "MapToFile",
              							"Args": {
								"enable": false, //para habilitar a escrita em arquivo altere esse valor      para 'true'
								"rollOnFileSizeLimit": true,
                								"rollingInterval": "Day",
                								"fileSizeLimitBytes": 1073741824,
                								"retainedFileCountLimit": 31,
			    					"outputTemplate": "{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}"
              }
            }
          ]
        }
      }
    ]
  							}
						}
					]
				}
			}
		]
	}
}

2.3 ARQUIVO DE CONFIGURAÇÃO EXPURGO DE ARQUIVOS

Informações

icon	false
title	Exemplo excluir arquivos com mais de 7 dias

Download: purge-files-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],
    		"WriteTo": [
       			{
		  		"Name": "Async",
		  		"Args": {
					"configure": [
				  		{
							"Name": "MapToFile",
							"Args": {
								"rollOnFileSizeLimitenable": "true"false, //Habilitapara umhabilitar tamanhoa limiteescrita paraem oarquivo arquivoaltere de log
esse valor para 'true'                     
								"rollOnFileSizeLimit": true, //Habilita um tamanho limite para o arquivo de log
								"fileSizeLimitBytes": "52428800", // Especifica o tamanho de cada arquivo de log
								"rollingInterval": "Day", //Criar um novo arquivo a cada dia
								"retainedFileCountLimit": "100", //Limite máximo de arquivos se ultrapassar esse valor o sistema exclui os mais antigos
								"retainedFileTimeLimit": "7.00:00:00", //Exclui arquivos com mais de 7 dias 
				}
			  }
						}
					]
		  		}
			}
    		]
  	}
}

2.4

...

EXEMPLOS DE CONFIGURAÇÕES

2.4.1 Registrar log somente no console

Informações

icon	false
title	Registrar log somente no console

Download: console-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],
    		"WriteTo": [        
	  		{
			  	"Name": "Console",
		  		"Args": {
					"theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
					"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} {Legacy} [{Level:u3}] {Message:lj} {EnvironmentUserName} {EnvironmentName}- <{ThreadId}>{NewLine}{ExceptionDetails}"
			  	}
	  		}
     		]
  	}
}

2.4.2 Registrar log somente no Seq

Informações

icon	false
title	Registrar log somente no Seq

Download: seq-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    "		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],     
		"WriteTo": [
      {
        			{
				"Name": "Seq",
        				"Args": { 
					"serverUrl": "http://localhost:5341" }
      }
    ]
   }
}
				}
			}
		]
	}
}

2.4.3 Registrar log somente no Arquivo, excluindo arquivos antigos a cada 7 após serem criados

Informações

icon	false
title	Registrar log somente no Arquivo, excluindo arquivos antigos a cada 7 dias após serem criados.

Download: last-seven-days-purge-files-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],     
		"WriteTo": [
      {
        			{
				"Name": "Async",
        				"Args": {
          					"configure": [
            {
              						{
							"Name": "MapToFile",
              "Args": {							"Args": {
								"enable": false, //para habilitar a escrita em arquivo altere esse valor para 'true'                     
								"rollingInterval": "Day",
								"fileSizeLimitBytes": "52428800",
								"rollOnFileSizeLimit": "true",
								"retainedFileCountLimit": "100",
								"retainedFileTimeLimit": "7.00:00:00", //Deletes files older than 7 days
								"outputTemplate":"{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}"
							              }
            }
          ]
        }
      }
    ]
   }
}}
						}
					]
				}
			}
		]
	}
}

2.4.4 Registrar logs somente de erro ou superior no Arquivo, excluindo arquivos antigos a cada 7 dias após serem criados.

Informações

icon	false
title	Registrar logs somente de erro ou superior no Arquivo, excluindo arquivos antigos a cada 7 dias após serem criados.

Download: error-level-last-seven-days-purge-files-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],  
		"MinimumLevel": "Error", 
		"WriteTo": [
      {
        			{
				"Name": "Async",
        				"Args": {
          					"configure": [
            {
              						{
							"Name": "MapToFile",
              "Args": {
											"Args": {
								"enable": false, //para habilitar a escrita em arquivo altere esse valor para 'true'    
								"rollingInterval": "Day",
								"fileSizeLimitBytes": "52428800",
								"rollOnFileSizeLimit": "true",
								"retainedFileCountLimit": "100",
								"retainedFileTimeLimit": "7.00:00:00", //Deletes files older than 7 days
								"outputTemplate": "{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}"
              }
            }
          ]
        }
      }
    ]
   }
}							}
						}
					]
				}
			}
		]
	}
}

2.4.5 Definindo o path para especificar onde os arquivos de logs devem ser salvos.

Informações

icon	false
title	Definindo o path para especificar onde os arquivos de logs devem ser salvos

Download: output-path-appsettings.log.json

Bloco de código

language	js
theme	RDark
linenumbers	true

{
  	"Serilog": {
    		"Using": [
			"Serilog", 
			"Serilog.Enrichers.Environment", 
			"Serilog.Enrichers.Process", 
			"Serilog.Settings.Configuration", 
			"Serilog.Sinks.Seq", 
			"Serilog.Expressions", 
			"RM.Lib.Monitoring.Tracklog"
		],
    		"Enrich": [ 
			"FromLogContext", 
			"WithMachineName", 
			"WithProcessId", 
			"WithThreadId", 
			"WithEnvironmentUserName", 
			"WithEnvironmentName"
		],  
		"MinimumLevel": "Error",
		"WriteTo": [
      {
        			{
				"Name": "Async",
        				"Args": {
          					"configure": [
            {
              						{
							"Name": "MapToFile",
							"Args": {
								"enable": false, //para habilitar a escrita em arquivo altere esse valor para 'true'  "Args": {
							 	"path": "C:\\TOTVS\\RM\\Logs\\",
								"rollingInterval": "Day",
								"fileSizeLimitBytes": "52428800",
								"rollOnFileSizeLimit": "true",
								"retainedFileCountLimit": "100",
								"retainedFileTimeLimit": "7.00:00:00", //Deletes files older than 7 days
								"outputTemplate":"{SourceContext}{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} {Legacy} [{Level:u3}] {Message:lj} ({EnvironmentName}|{EnvironmentUserName}) <{ThreadId}:{ThreadName}>[{ProcessId}:{ProcessName}] [{CallerFilePath} - ({CallerLineNumber}) - {CallerMemberName}] [{ModuleMessage:lj}, ({EnvironmentName}|{CategoryEnvironmentUserName},) <{FuncionalityThreadId}] :{NewLineThreadName}>[{Exception}"
              }
            }
          ]
        }
      }
    ]
   }
}ProcessId}:{ProcessName}] [{CallerFilePath} - ({CallerLineNumber}) - {CallerMemberName}] [{Module}, {Category}, {Funcionality}] {NewLine}{Exception}"
							  }
						}
					]
				}
			}
		]
	}
}

Índice

Dica

title	Lembre-se

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

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 26

Nova versão Atual

Chave

2.3 ARQUIVO DE CONFIGURAÇÃO EXPURGO DE ARQUIVOS

2.4

EXEMPLOS DE CONFIGURAÇÕES

2.4.1 Registrar log somente no console

2.4.2 Registrar log somente no Seq

2.4.3 Registrar log somente no Arquivo, excluindo arquivos antigos a cada 7 após serem criados

2.4.4 Registrar logs somente de erro ou superior no Arquivo, excluindo arquivos antigos a cada 7 dias após serem criados.

2.4.5 Definindo o path para especificar onde os arquivos de logs devem ser salvos.