Descrição de arquivos de histórico
Aplicações 4D podem gerar vários arquivos de histórico ou log que são úteis para depuração e otimizar sua execução. Logs are usually started or stopped using selectors of the SET DATABASE PARAMETER or WEB SET OPTION commands and are stored in the Logs folder of the project.
Informação gravada precisa ser analisada para detectar e corrigir os problemas. Esta seção oferece uma descrição detalhada dos arquivos de log abaixo:
- 4DRequestsLog.txt
- 4DRequestsLog_ProcessInfo.txt
- HTTPDebugLog.txt
- 4DDebugLog.txt (padrão & tabular)
- 4DDiagnosticLog.txt
- 4DIMAPLog.txt
- 4DPOP3Log.txt
- 4DSMTPLog.txt
- Petições de arquivo de log por cliente ORDA
Note: When a log file can be generated either on 4D Server or on the remote client, the word "Server" is added to the server-side log file name, for example "4DRequestsLogServer.txt"
Arquivos de Histórico compartilham alguns campos para que possa estabelecer uma cronologia e fazer conexões entre entradas quando depurar:
sequence_number: esse número é unico entre todos os arquivos de histórico e é aumentado a cada nova entrada qualquer que seja o arquivo de log, para que possa saber a sequência exata das operações.connection_uuid: para qualquer processo 4D criado em um cliente 4D que conecte a u m servidor, essa conexão UUID é registrada tanto no servior quanto no lado do cliente. Permite que facilmente identifique o cliente remoto que lança cada processo.
4DRequestsLog.txt
Esses arquivos de histórico gravam petições normais realizadas pela máquina 4D Server ou a máquina remota 4D que executaram o comando (excluindo petições Web).
Como iniciar esse log:
- no servidor:
SET DATABASE PARAMETER(4D Server log recording;1)
//lado servidor
- em um cliente:
SET DATABASE PARAMETER(Client Log Recording;1)
//lado remoto
Esta declaração também começa o arquivo de histórico 4DRequestsLog.txt.
Cabeçalhos
Este arquivo começa com os cabeçalhos abaixo:
- Identificador de sessão de histórico
- Hostname do servidor que hospeda a aplicação
- Nome login Usuário: login do SO do usuário que roda a aplicação 4D no servidor.
Conteúdos
Para cada petição, os campos abaixo estão logados:
| Campo nome | Descrição |
|---|---|
| sequence_number | Número de operação único e sequencial da sessão de histórico |
| time | Data e hora usando formato ISO 8601: 'YYYY-MM-DDTHH:MM:SS.mmm' |
| systemid | ID de sistema |
| componente | Assinatura de componente (por exemplo '4SQLS' ou 'dbmg') |
| process_info_ | index Corresponds to the "index" field in 4DRequestsLog_ProcessInfo.txt log, and permits linking a request to a process. |
| request | ID de petição em C/S ou string de mensagem para petições SQL ou mensagens LOG EVENT |
| bytes_in | Número de bytes recebidos |
| bytes_out | Número de bytes enviados |
| server_duration | exec_duration | Depende de onde o histórico for gerado: |
| write_duration | Tempo que levou em microssegundos para enviar: |
| task_kind | Preemptivo ou cooperativo (respectivamente 'p' ou 'c') |
| rtt | Tempo estimado em microssegundos para o cliente enviar a petição e o servidor para reconhecê-la. A a D e E a H na imagem abaixo. |
Fluxo de petição:
4DRequestsLog_ProcessInfo.txt
Este arquivo de histórico registra a informação em cada processo criado na máquina 4D Server ou na máquina remota 4D que executa o comando (excluindo petições Web).
Como iniciar esse log:
- no servidor:
SET DATABASE PARAMETER(4D Server log recording;1) //lado servidor
- em um cliente:
SET DATABASE PARAMETER(Client Log Recording;1) //lado remoto
Esta declaração também começa um arquivo de histórico 4DRequestsLog_ProcessInfo.txt.
Cabeçalhos
Este arquivo começa com os cabeçalhos abaixo:
- Identificador de sessão de histórico
- Hostname do servidor que hospeda a aplicação
- Nome login Usuário: login do SO do usuário que roda a aplicação 4D no servidor.
Conteúdos
Para cada processo, os campos abaixo são registrados:
| Campo nome | Descrição |
|---|---|
| sequence_number | Número de operação único e sequencial da sessão de histórico |
| time | Hora e data usando o formato ISO 8601 format: "YYYY-MM-DDTHH:MM:SS.mmm" |
| process_info_index | Número de processo único e sequencial |
| CDB4DBaseContext | DB4D contexto de componente database UUID |
| systemid | ID de sistema |
| server_process_id | ID de processo no servidor |
| remote_process_id | Id de processo no cliente |
| process_name | Nome de processo |
| cID | Identificador de conexão 4D |
| uID | Identificador de Cliente 4D |
| IP Client | IPv4/IPv6アドレス |
| host_name | Hostname do cliente |
| user_name | Nome de login de usuário no cliente |
| connection_uuid | Identificador UUID da conexão de processo |
| server_process_unique_id | ID de Processo único em Servidor |
HTTPDebugLog.txt
Este arquivo registra cada petição HTTP e cada resposta em modo raw (não processado). Petições inteiras, incluindo cabeçalhos, são registradas; opcionalmente, partes do corpo podem ser registradas também.
Como iniciar esse log:
WEB SET OPTION(Web debug log;wdl enable without body)
//outros valores estão disponíveis
Os campos abaixo são registrados tanto para Request quanto para Response:
| Campo nome | Descrição |
|---|---|
| SocketID | ID da socked usada para comunicação |
| PeerIP | Endereço IPv4 do host (cliente) |
| PeerPort | Porta usada por host (cliente) |
| TimeStamp | Timestamp em milisegundos (desde início sistema) |
| ConnectionID | Connection UUID (UUID de VTCPSocket usada para comunicação) |
| SequenceNumber | Número de operação único e sequencial da sessão de histórico |
4DDebugLog.txt (standard)
Esses registros de histórico gravam cada evento que ocorreu ao nível de programação de 4D. Modo padrão oferece uma vista básica de eventos.
Como iniciar esse log:
SET DATABASE PARAMETER(Debug Log Recording;2)
//standard, all processes SET DATABASE PARAMETER(Current process debug log recording;2)
//standard, current process only
Os campos abaixo estão registrados para cada evento:
| Coluna # | Descrição |
|---|---|
| 1 | Número de operação único e sequencial da sessão de histórico |
| 2 | Data e hora em formato ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
| 3 | ID de processo (p=xx) e ID de processo único (puid=xx) |
| 4 | Nível de stack |
| 5 | Pode ser Command Name/ Method Name/Message/ Task Start Stop info/Plugin Name, event ou Callback/Connection UUID |
| 6 | Tempo que leva para a operação de histórico em milissegundos |
4DDebugLog.txt (tabular)
Esse arquivo de histórico registra cada evento que ocorrer ao nível de programação 4D em um formato tabulado e compacto que inclui informação adicional (comparado ao formato padrão).
Como iniciar esse log:
SET DATABASE PARAMETER(Debug Log Recording;2+4)
//extended tabbed format, all processes SET DATABASE PARAMETER(Current process debug log recording;2+4)
//extended, current process only
Os campos abaixo estão registrados para cada evento:
| Coluna # | Campo nome | Descrição |
|---|---|---|
| 1 | sequence_number | Número de operação único e sequencial da sessão de histórico |
| 2 | time | Data e hora em formato ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
| 3 | ProcessID | Process ID |
| 4 | unique_processID | ID de processo |
| 5 | stack_level | Nível de stack |
| 6 | operation_type | Tipo operação histórico. Esse valor pode ser um valor absoluto:
operation_type, operation e operation_parameters tem o mesmo valor que o nível de stack registrado na coluna stack_opening_sequence_number column. Por exemplo:
|
| 7 | operation | Pode representar (dependendo do tipo da operação): |
| 8 | operation_parameters | Parâmetros passados a comandos, métodos ou plugins |
| 9 | form_event | Evento formulário se houver: vazio em outros casos (suponha que a coluna é usada quando o código for executado em um método formulário ou método objeto) |
| 10 | stack_opening_sequence_number | Só para níveis stack fechamento: número sequencia do nível correspondente de abertura de stack |
| 11 | stack_level_execution_time | Só para níveis de stack de fechamento: tempo decorrido em microssegundos da ação de histórico atual; só para os níveis de stack de fechamento (ver décima coluna em linhas 123 e 124 no histórico acima) |
4DDiagnosticLog.txt
Esse arquivo registra vários eventos relacionados à operação de aplicação e sua leitura humana. Pode incluir informação personalizada nesse arquivo usando o comando LOG EVENT
Como iniciar esse log:
SET DATABASE PARAMETER(Diagnostic log recording;1) //começa o registro
Os campos abaixo estão registrados para cada evento:
| Nome de campo | Descrição |
|---|---|
| sequenceNumber | Número de operação único e sequencial da sessão de histórico |
| timestamp | Data e hora em formato ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
| loggerID | Opcional |
| componentSignature | Opcional - assinatura interna de componente |
| messageLevel | Informação, Aviso, Erro |
| message | Descrição da entrada de histórico |
Dependendo do evento, vários outros campos podem ser registrados, como task, socket, etc.
4DSMTPLog.txt, 4DPOP3Log.txt, e 4DIMAPLog.txt
Esses históricos registram cada troca entre a aplicação 4D e o servidor de mail (SMTP, POP3, IMAP) que foram iniciados pelos comandos abaixo:
- SMTP - SMTP New transporter
- POP3 - POP3 New transporter
- IMAP - IMAP New transporter
Os arquivos de histórico podem ser produzidos em duas versões:
- uma versão comum:
- chamada 4DSMTPLog.txt, 4DPOP3Log.txt, ou 4DIMAPLog.txt
- sem anexos
- usa um arquivo circular automático que é reciclado a cada 10MB
- para depurações comuns
Para começar esse histórico:
SET DATABASE PARAMETER(SMTP Log;1) //start SMTP log
SET DATABASE PARAMETER(POP3 Log;1) //start POP3 log
SET DATABASE PARAMETER(IMAP Log;1) //start IMAP log
4D Server: Click on the Start Request and Debug Logs button in the Maintenance Page of the 4D Server administration window.
A rota do histórico é retornada pelo comando Get 4D file.
- uma versão estendida:
- attachment(s) included no automatic recycling
- nome personalizado
- guardado para propósitos específicos
Para começar esse histórico:
$server:=New object
...
//SMTP
$server.logFile:="MySMTPAuthLog.txt"
$transporter:=SMTP New transporter($server)
// POP3
$server.logFile:="MyPOP3AuthLog.txt"
$transporter:=POP3 New transporter($server)
//IMAP
$server.logFile:="MyIMAPAuthLog.txt"
$transporter:=IMAP New transporter($server)
Conteúdos
Para cada petição, os campos abaixo estão logados:
| Coluna # | Descrição |
|---|---|
| 1 | Número de operação único e sequencial da sessão de histórico |
| 2 | Data e hora em formato RFC3339 (yyyy-mm-ddThh:mm:ss.ms) |
| 3 | ID de 4D Process |
| 4 | ID de processo |
| 5 |
|
Petições cliente ORDA
Esse registro grava cada petição ORDA enviada de uma máquina remota. Pode dirigir informação de histórico a uma memória ou a um arquivo em disco. O nome e rota desse arquivo pode ser escolhido.
Como iniciar esse log:
//para executar em uma máquina remota
ds.startRequestLog(File("/PACKAGE/Logs/ordaLog.txt"))
//também pode ser enviado a memória
Se quiser usar esse número de sequência único em histórico de petições ORDA, necessita ativá-lo:
//to be executed on a remote machine SET DATABASE PARAMETER(Client Log Recording;1)
//to enable log sequence number
ds.startRequestLog(File("/PACKAGE/Logs/ordaLog.txt"))
//can be also sent to memory SET DATABASE PARAMETER(Client Log Recording;0)
//disabling sequence number
Os campos abaixo são registrados para cada petição:
| Campo nome | Descrição | Exemplo |
|---|---|---|
| sequenceNumber | Número de operação único e sequencial da sessão de histórico | 104 |
| url | URL de petição de cliente ORDA | "rest/Persons(30001)" |
| startTime | Data e hora de início utilizando o formato ISO 8601 | "2019-05-28T08:25:12.346Z" |
| endTime | Data e hora final usando formato ISO 8601 | "2019-05-28T08:25:12.371Z" |
| duration | Duração de processamento do cliente (ms) | 25 |
| response | Objeto resposta servidor | {"status":200,"body":{"__entityModel":"Persons",[...] |