Description des fichiers d'historique
Les applications 4D peuvent générer divers fichiers d'historique (ou "logs") qui sont utiles pour le débogage ou l'optimisation de leur exécution. 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.
Les informations de l'historique doivent être analysées pour détecter et corriger les problèmes. Cette section fournit une description complète des fichiers d'historique suivants :
- 4DRequestsLog.txt
- 4DRequestsLog_ProcessInfo.txt
- HTTPDebugLog.txt
- 4DDebugLog.txt (standard & tabular)
- 4DDiagnosticLog.txt
- 4DIMAPLog.txt
- 4DPOP3Log.txt
- 4DSMTPLog.txt
- ORDA requests log file
Lorsqu'un fichier d'historique peut être généré soit sur 4D Server, soit sur le client distant, le mot " Server " est ajouté au nom du fichier d'historique côté serveur, par exemple " 4DRequestsLogServer.txt"
Les fichiers de logs partagent certains champs, ce qui vous permet d'établir une chronologie et de faire des connexions entre les entrées lors du debugging :
sequence_number
: ce numéro est unique parmi tous les fichiers d'historique de débogage et est incrémenté à chaque nouvelle entrée, quel que soit le fichier d'historique, de manière à ce que vous puissiez connaître la séquence exacte des opérations.connection_uuid
: pour chaque process 4D créé sur un client 4D qui se connecte au serveur, cet UUID de connexion est stocké à la fois côté serveur et client. Il vous permet d'identifier facilement le client distant qui a lancé le process.
4DRequestsLog.txt
Ce fichier de logs enregistre les requêtes standard envoyées par la machine du 4D Server, ou la machine à distance qui a exécuté la commande (requêtes web exclues).
Pour lancer cet historique :
- sur le serveur :
SET DATABASE PARAMETER(4D Server log recording;1)
//côté serveur
- sur le client :
SET DATABASE PARAMETER(Client Log Recording;1)
//côté distant
Cette instruction démarre également le fichier d'historique 4DRequestsLog_ProcessInfo.txt.
En-têtes
Ce fichier commence avec les en-têtes suivants :
- Log Session Identifier (Identifiant de session d'historique)
- Nom du serveur qui héberge l'application
- User Login Name : Nom de l'utilisateur (défini dans l'OS) qui a exécuté l'application 4D sur le serveur.
Contenu
Pour chaque requête, les champs suivants sont enregistrés :
Noms des champs | Description |
---|---|
sequence_number | Numéro d'opération séquentiel et unique dans la session d'historique |
time | Date et heure au format ISO 8601 : 'YYYY-MM-DDTHH:MM:SS.mmm' |
systemid | ID système |
component | Signature du composant (par exemple '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 | C/S or ORDA request ID or message string for SQL requests or LOG EVENT messages |
bytes_in | Nombre d'octets reçus |
bytes_out | Nombre d'octets envoyés |
server_duration | exec_duration | Dépend de l'endroit où l'historique est généré : |
write_duration | Temps en microsecondes pour envoyer : |
task_kind | Préemptif ou coopératif (respectivement 'p' ou 'c') |
rtt | Temps en microsecondes pris par le client pour envoyer la requête et pour qu'elle soit reçue par le serveur. Correspond respectivement aux chemins A vers D et E vers H dans l'image ci-dessous. |
extra | Additional information related to the context, for example dataclass name and/or attribute name in case of ORDA request |
Acheminement de la requête :
4DRequestsLog_ProcessInfo.txt
Ce fichier de logs enregistre des informations sur chaque process créé sur la machine du 4D Server, ou la machine à distance qui a exécuté la commande (requêtes web exclues).
Pour lancer cet historique :
- sur le serveur :
SET DATABASE PARAMETER(4D Server log recording;1) //côté serveur
- sur le client :
SET DATABASE PARAMETER(Client Log Recording;1) //côté distant
Cette déclaration démarre également l'historique du fichier 4DRequestsLog.txt.
En-têtes
Ce fichier commence avec les en-têtes suivants :
- Log Session Identifier (Identifiant de session d'historique)
- Nom du serveur qui héberge l'application
- User Login Name : Nom de l'utilisateur (défini dans l'OS) qui a exécuté l'application 4D sur le serveur.
Contenu
Pour chaque process, les champs suivants sont enregistrés :
Noms des champs | Description |
---|---|
sequence_number | Numéro d'opération séquentiel et unique dans la session d'historique |
time | Date et heure au format ISO 8601 : "YYYY-MM-DDTHH:MM:SS.mmm" |
process_info_index | Numéro de process séquentiel et unique |
CDB4DBaseContext | UUID du contexte de base du composant DB4D |
systemid | ID système |
server_process_id | ID du process sur le serveur |
remote_process_id | ID du process sur le client |
process_name | Nom du process |
cID | Identifiant de la connexion 4D |
uID | Identifiant du client 4D |
IP Client | Addresse IPv4/IPv6 du client |
host_name | Nom d'hôte du client |
user_name | Nom de connexion utilisateur sur le client |
connection_uuid | Identifiant UUID de process de connexion |
server_process_unique_id | ID unique du process sur le serveur |
HTTPDebugLog.txt
Ce fichier d'historique enregistre chaque requête HTTP et chaque réponse en mode brut (raw). Les requêtes sont enregistrées dans leur totalité (en-têtes compris). Les parts du body peuvent également être enregistrées.
Pour lancer cet historique :
WEB SET OPTION(Web debug log;wdl enable without body)
//d'autres valeurs sont disponibles
Les champs suivants sont enregistrés pour Requête et Réponse :
Noms des champs | Description |
---|---|
SocketID | ID du socket utilisé pour la communication |
PeerIP | Adresse IPv4 de l'hôte (client) |
PeerPort | Port utilisé par l'hôte (client) |
TimeStamp | Horodatage en millisecondes (depuis le démarrage du système) |
ConnectionID | Connexion UUID (UUID du VTCPSocket utilisé pour la communication) |
SequenceNumber | Numéro d'opération séquentiel et unique dans la session d'historique |
4DDebugLog.txt (standard)
Ce fichier d'historique enregistre chaque évènement qui a lieu au niveau de la programmation 4D. Le mode standard offre une vue d'ensemble des évènements.
Pour lancer cet historique :
SET DATABASE PARAMETER(Debug Log Recording;2)
//standard, tous les process
SET DATABASE PARAMETER(Current process debug log recording;2)
//standard, process courant uniquement
Les champs suivants sont enregistrés pour chaque évènement :
Colonne # | Description |
---|---|
1 | Numéro d'opération séquentiel et unique dans la session d'historique |
2 | Date et heure au format ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
3 | ID process (p=xx) et ID unique process (puid=xx) |
4 | Niveau de stack (pile) |
5 | Peut être Nom de commande / Nom de méthode / Message / Info Start Stop task / Nom, événement ou callback plugin / UUID connexion |
6 | Durée de l'opération de connexion en millisecondes (différent 2e colonne) |
4DDebugLog.txt (tabulé)
Ce fichier de logs enregistre chaque évènement au niveau de la programmation 4D sous un format compact avec des tabulations, qui inclut des informations supplémentaires par rapport au format standard.
Pour lancer cet historique :
SET DATABASE PARAMETER(Debug Log Recording;2+4)
//format tabulé étendu, tous les process
SET DATABASE PARAMETER(Current process debug log recording;2+4)
//étendu, process courant uniquement
Les champs suivants sont enregistrés pour chaque évènement :
Colonne # | Noms des champs | Description |
---|---|---|
1 | sequence_number | Numéro d'opération séquentiel et unique dans la session d'historique |
2 | time | Date et heure au format ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
3 | ProcessID | ID du process |
4 | unique_processID | ID unique du process |
5 | stack_level | Niveau de stack (pile) |
6 | operation_type | Type d'opération enregistrée. Il peut s'agir d'une valeur absolue :
operation_type , operation et operation_parameters ont la même valeur que le niveau de stack d'ouverture enregistré dans la colonne stack_opening_sequence_number . Par exemple :
|
7 | operation | Peut représenter (en fonction du type d'opération) : |
8 | operation_parameters | Paramètres passés aux commandes, méthodes ou aux plugins |
9 | form_event | Evénement formulaire, le cas échéant ; vide dans les autres cas (par conséquent cette colonne est utilisée lorsque le code est exécuté dans une méthode formulaire ou méthode objet) |
10 | stack_opening_sequence_number | Niveaux de fermeture de stacks uniquement : numéro de séquence du niveau d'ouverture de stack correspondant |
11 | stack_level_execution_time | Niveaux de fermeture de stacks uniquement : Durée en micro secondes de l'action enregistrée courante (cf. 10e colonne des lignes 123 et 124 dans l'historique ci-dessus) |
4DDiagnosticLog.txt
Ce fichier d'historique enregistre de nombreux événements liés au fonctionnement interne de l'application et est lisible par un humain. Vous pouvez inclure des informations personnalisées dans ce fichier à l'aide de la commande LOG EVENT.
Pour lancer cet historique :
SET DATABASE PARAMETER(Diagnostic log recording;1) //lancer l'enregistrement
Les champs suivants sont enregistrés pour chaque évènement :
Nom des champs | Description |
---|---|
sequenceNumber | Numéro d'opération séquentiel et unique dans la session d'historique |
timestamp | Date et heure au format ISO 8601 (YYYY-MM-DDThh:mm:ss.mmm) |
loggerID | Optionnel |
componentSignature | Optionnel - signature de composant interne |
messageLevel | Info, Attention, Erreur |
message | Description de la saisie de journal |
En fonction de l'événement, d'autres champs peuvent également être enregistrés, tels que task, socket, etc.
Activation du fichier
The 4DDiagnosticLog.txt file can log different levels of messages, from ERROR
(most important) to TRACE
(less important). By default, the INFO
level is set, which means that the file will log only important events, including errors and unexpected results (see below).
You can select the level of messages using the Diagnostic log level
selector of the SET DATABASE PARAMETER command, depending on your needs. When you select a level, levels above (which are more important) are implicitely selected also. The following levels are available:
Colonne # | Description | When selected, includes |
---|---|---|
ERROR | Numéro d'opération séquentiel et unique dans la session d'historique | ERROR |
WARN | Date et heure au format RFC3339 (yyyy-mm-ddThh:mm:ss.ms) | ERROR, WARN |
INFO | ID du Process 4D | ERROR, WARN, INFO |
DEBUG | ID unique du process | ERROR, WARN, INFO, DEBUG |
TRACE | Other internal information (for 4D technical services) | ERROR, WARN, INFO, DEBUG, TRACE |
4DSMTPLog.txt, 4DPOP3Log.txt, et 4DIMAPLog.txt
Ces fichiers d'historique enregistrent chaque échange entre l'application 4D et le serveur de mail (SMTP, POP3, IMAP) initialisé par les commandes suivantes :
- SMTP - SMTP New transporter
- POP3 - POP3 New transporter
- IMAP - IMAP New transporter
Les fichiers d'historique peuvent être générés en deux versions :
une version classique :
- fichiers nommés 4DSMTPLog.txt, 4DPOP3Log.txt, ou 4DIMAPLog.txt
- sans pièces jointes
- avec un recyclage automatique tous les 10 MB
- conçue pour des fonctions de débogage habituelles
Pour lancer cet historique :
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 : Cliquez sur le bouton Démarrer les journaux de requêtes et de débogage dans la Page Maintenance de la fenêtre d'administration de 4D Server.
Ce chemin d'accès au journal est retourné par la commande Get 4D file
.
une version étendue :
- attachment(s) included no automatic recycling
- nom personnalisé
- conçue à des fins spécifiques
Pour lancer cet historique :
$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)
Contenu
Pour chaque requête, les champs suivants sont enregistrés :
Colonne # | Description |
---|---|
1 | Numéro d'opération séquentiel et unique dans la session d'historique |
2 | Date et heure au format RFC3339 (yyyy-mm-ddThh:mm:ss.ms) |
3 | ID du Process 4D |
4 | ID unique du process |
5 |
|
ORDA requests
ORDA requests logs can record each ORDA request and server response. Two ORDA requests logs are available:
- a client-side ORDA request log, in .txt format
- a server-side ORDA request log, in .jsonl format
Client-side
The client-side ORDA log records each ORDA request sent from a remote machine. You can direct log information to memory or to a .txt file on disk of the remote machine. Vous pouvez choisir le nom et l'emplacement de ce fichier journal.
Pour lancer cet historique :
//on a remote machine
SET DATABASE PARAMETER(Client Log Recording;1)
ds.startRequestLog(File("/PACKAGE/Logs/ordaLog.txt"))
//can be also sent to memory
SET DATABASE PARAMETER(Client Log Recording;0)
Triggering the client-side 4DRequestsLog.txt using SET DATABASE PARAMETER
is not mandatory. However, it is required if you want to log the unique sequenceNumber
field.
Les champs suivants sont enregistrés pour chaque requête :
Noms des champs | Description | Exemple |
---|---|---|
sequenceNumber | Numéro d'opération séquentiel et unique dans la session d'historique | 104 |
url | Request URL | "rest/Persons(30001)" |
startTime | Date et heure de début au format ISO 8601 | "2019-05-28T08:25:12.346Z" |
endTime | Date et heure de fin au format ISO 8601 | "2019-05-28T08:25:12.371Z" |
duration | Client processing duration in milliseconds (ms) | 25 |
response | Objet réponse du serveur | {"status":200,"body":{"__entityModel":"Persons",[...]}} |
Exemple
Here is an example of a client-side ORDA log file record:
{
"sequenceNumber": 7880,
"url": "rest/Employees/$entityset/F910C2E4A2EE6B43BBEE74A0A4F68E5A/Salary?$compute='sum'&$progress4Dinfo='D0706F1E77D4F24985BE4DDE9FFA1739'",
"startTime": "2023-05-15T10:43:39.400Z",
"endTime": "2023-05-15T10:43:39.419Z",
"duration": 19,
"response": {
"status": 200,
"body": 75651
}
}
Server-side
The server-side ORDA log records each ORDA request processed by the server, as well as the server response (optional). Log information is saved in a .jsonl file on the server machine disk (by default, ordaRequests.jsonl).
Pour lancer cet historique :
//on the server
SET DATABASE PARAMETER(4D Server log recording;1)
ds.startRequestLog(File("/PACKAGE/Logs/ordaRequests.jsonl");srl log response without body)
//srl... parameter is optional
SET DATABASE PARAMETER(4D Server log recording;0)
Triggering the server-side 4DRequestsLog.txt using SET DATABASE PARAMETER
is not mandatory. However, it is required if you want to log the unique sequenceNumber
and the duration
fields.
Les champs suivants sont enregistrés pour chaque requête :
Noms des champs | Description | Exemple |
---|---|---|
sequenceNumber | Numéro d'opération séquentiel et unique dans la session d'historique | 104 |
url | Request URL | "rest/Persons(30001)" |
startTime | Date et heure de début au format ISO 8601 | "2019-05-28T08:25:12.346Z" |
duration | Server processing duration in microseconds (µ) | 2500 |
response | Server response object, can be configured in .startRequestLog() | {"status":200,"body":{"__entityModel":"Persons",[...]}} |
ipAddress | User IP address | "192.168.1.5" |
userName | Name of the 4D user | "henry" |
systemUserName | Login name of the user on the machine | "hsmith" |
machineName | Name of the user machine | "PC of Henry Smith" |
Exemple
Here is an example of a server-side ORDA log record:
{
"url": "rest/Employees/$entityset/F910C2E4A2EE6B43BBEE74A0A4F68E5A/Salary?$compute='sum'&$progress4Dinfo='D0706F1E77D4F24985BE4DDE9FFA1739'",
"systemUserName": "Admin",
"userName": "Designer",
"machineName": "DESKTOP-QSK9738",
"taskID": 5,
"taskName": "P_1",
"startTime": "2023-05-15T11:43:39.401",
"response": {
"status": 200,
"body": 75651
},
"sequenceNumber": 7008,
"duration": 240
}
Utilisation d'un fichier de configuration de log
Vous pouvez utiliser un fichier de configuration de log pour gérer facilement l'enregistrement des journaux dans un environnement de production. Ce fichier est préconfiguré par le développeur. En général, il peut être envoyé aux clients pour qu'ils n'aient qu'à le sélectionner ou à le copier dans un dossier local. Une fois activé, le fichier de configuration de log déclenche l'enregistrement de journaux spécifiques.
Activation du fichier
There are several ways to enable the log configuration file, depending on your configuration:
- 4D Server with interface: you can open the Maintenance page and click on the Load logs configuration file button, then select the file. Dans ce cas, vous pouvez utiliser n'importe quel nom pour le fichier de configuration. Il est immédiatement activé sur le serveur.
- an interpreted or compiled project: the file must be named
logConfig.json
and copied in the Settings folder of the project (located at the same level as theProject
folder). Il est activé au démarrage du projet (uniquement sur le serveur en client/serveur). - a built application: the file must be named
logConfig.json
and copied in the following folder:- Windows :
Users\[userName]\AppData\Roaming\[application]
- macOS :
/Users/[userName]/Library/ApplicationSupport/[application]
- Windows :
- all projects with a stand-alone or remote 4D: the file must be named
logConfig.json
and copied in the following folder:- Windows:
Users\[userName]\AppData\Roaming\4D
- macOS:
/Users/[userName]/Library/ApplicationSupport/4D
- Windows:
- all projects with 4D Server: the file must be named
logConfig.json
and copied in the following folder:- Windows:
Users\[userName]\AppData\Roaming\4D Server
- macOS:
/Users/[userName]/Library/ApplicationSupport/4D Server
- Windows:
If a logConfig.json
file is installed in both Settings and AppData/Library folders, the Settings folder file will have priority.
Description du fichier JSON
The log configuration file is a .json
file that must comply with the following json schema:
{
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Logs Configuration File",
"description": "A file that controls the state of different types of logs in 4D clients and servers",
"type": "object",
"properties": {
"forceConfiguration": {
"description": "Forcing the logs configuration described in the file ingoring changes coming from code or user interface",
"type": "boolean",
"default": true
},
"requestLogs": {
"description": "Configuration for request logs",
"type": "object",
"properties": {
"clientState": {
"description": "Enable/Disable client request logs (from 0 to N)",
"type": "integer",
"minimum": 0
},
"serverState": {
"description": "Enable/Disable server request logs (from 0 to N)",
"type": "integer",
"minimum": 0
}
}
},
"debugLogs": {
"description": "Configuration for debug logs",
"type": "object",
"properties": {
"commandList": {
"description": "Commands to log or not log",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"state": {
"description": "integer to specify type of debuglog and options",
"type": "integer",
"minimum": 0
}
}
},
"diagnosticLogs":{
"description": "Configuration for debug logs",
"type": "object",
"properties": {
"state":{
"description": "Enable/Disable diagnostic logs 0 or 1 (0 = do not record, 1 = record)",
"type": "integer",
"minimum": 0
},
"level": {
"description": "Configure diagnostic logs",
"type": "integer",
"minimum": 2,
"maximum": 6
}
}
},
"httpDebugLogs": {
"description": "Configuration for http debug logs",
"type": "object",
"properties": {
"level": {
"description": "Configure http request logs",
"type": "integer",
"minimum": 0,
"maximum": 7
},
"state": {
"description": "Enable/Disable recording of web requests",
"type": "integer",
"minimum": 0,
"maximum": 4
}
}
},
"POP3Logs": {
"description": "Configuration for POP3 logs",
"type": "object",
"properties": {
"state": {
"description": "Enable/Disable POP3 logs (from 0 to N)",
"type": "integer",
"minimum": 0
}
}
},
"SMTPLogs": {
"description": "Configuration for SMTP logs",
"type": "object",
"properties": {
"state": {
"description": "Enable/Disable SMTP log recording (form 0 to N)",
"type": "integer",
"minimum": 0
}
}
},
"IMAPLogs": {
"description": "Configuration for IMAP logs",
"type": "object",
"properties": {
"state": {
"description": "Enable/Disable IMAP log recording (form 0 to N)",
"type": "integer"
}
}
},
"ORDALogs": {
"description": "Configuration for ORDA logs",
"type": "object",
"properties": {
"state": {
"description": "Enable/Disable ORDA logs (0 or 1)",
"type": "integer"
},
"filename": {
"type": "string"
}
}
}
}
}
Exemple
Voici un exemple de fichier de configuration de log :
{
"forceLoggingConfiguration": false,
"requestLogs": {
"clientState": 1,
"serverState": 1
},
"debugLogs": {
"commandList":["322","311","112"],
"state": 4
},
"diagnosticLogs":{
"state" : 1
},
"httpDebugLogs": {
"level": 5,
"state" : 1
},
"POP3Logs": {
"state" : 1
},
"SMTPLogs": {
"state" : 1
},
"IMAPLogs": {
"state" : 1
},
"ORDALogs": {
"state" : 1,
"filename": "ORDALog.txt"
}
}