L'interface de contrôle Logger permet de créer des journaux dans le dossier log du volume de stockage courant.
Cette API est asynchrone et utilise Promise.
Pour utiliser cette API, vous devez dans un premier temps obtenir l'interface de contrôle Logger
à l'aide de IDAL.getControlInterfaces() ou IDAL.getRemoteControlInterfaces().
Méthodes
delete(id): Promise.<boolean> | Promise.<ErrorStatus>
Supprimer un fichier de journal.
Paramètres
| Nom | Type | Description |
|---|---|---|
id |
string | L'identifiant du fichier de journal (un nom de fichier). |
Valeur de retour
-
Une promesse résolue avec une valeur de type
boolean.- Type
- Promise.<boolean>
-
Une promesse rejetée avec une valeur de type ErrorStatus.
- Type
- Promise.<ErrorStatus>
list(): Promise.<Array.<string>> | Promise.<ErrorStatus>
Obtenir la liste des identifiants de journaux existants.
Valeur de retour
-
Une promesse résolue avec un tableau de chaines de caractères, chaque élément étant un identifiant de fichier de log.
- Type
- Promise.<Array.<string>>
-
Une promesse rejetée avec une valeur de type ErrorStatus.
- Type
- Promise.<ErrorStatus>
log(id, message): Promise.<boolean> | Promise.<ErrorStatus>
Écrire un message dans un fichier journal.
Le fichier est stocké dans le dossier log du volume de stockage courant.
Paramètres
| Nom | Type | Description |
|---|---|---|
id |
string | L'identifiant du fichier de journal (un nom de fichier). |
message |
string | Le message à consigner dans le fichier. |
Valeur de retour
-
Une promesse résolue avec une valeur de type
boolean.- Type
- Promise.<boolean>
-
Une promesse rejetée avec une valeur de type ErrorStatus.
- Type
- Promise.<ErrorStatus>
read(id, offset, length): Promise.<ReadInfo> | Promise.<ErrorStatus>
Lire le contenu d'un fichier de journal.
Vous pouvez utiliser cette méthode pour obtenir le contenu d'un fichier de
journal, par exemple pour le transférer sur un serveur distant.
Les données retournée sont encodées en Base64 (et non pas une chaine brute), ceci pour éviter
tout problème d'encodage de caractères multi-octets.
Lorsque qu'il n'y a plus de données à lire à partir de l'offset donné, l'appel à cette méthode
retourne un ReadInfo dont la valeur de length est 0.
Paramètres
| Nom | Type | Description |
|---|---|---|
id |
string | L'identifiant du fichier de journal à lire. |
offset |
number | L'offset de lecture. |
length |
number | Le nombre maximum d'octets qui doivent être lus. |
Valeur de retour
-
Une promesse résolue avec les données du fichier de journal.
- Type
- Promise.<ReadInfo>
-
Une promesse rejetée avec une valeur de type ErrorStatus.
- Type
- Promise.<ErrorStatus>
stat(id): Promise.<StatInfo> | Promise.<ErrorStatus>
Obtenir le statut d'un fichier de journal (taille).
Paramètres
| Nom | Type | Description |
|---|---|---|
id |
string | L'identifiant du fichier de journal. |
Valeur de retour
-
Une promesse résolue avec le statut du fichier de journal.
- Type
- Promise.<StatInfo>
-
Une promesse rejetée avec une valeur de type ErrorStatus.
- Type
- Promise.<ErrorStatus>
Définition des types
ReadInfo
Un ReadInfo Contient le résultat d'un appel à Logger.read().
Propriétés
| Nom | Type | Description |
|---|---|---|
data |
string | Une chaine Base64 encodant les données lues dans un fichier de journal. |
length |
number | Est le nombre d'octets qui ont été lus. Attention, il ne s'agit pas de
la longueur de |
StatInfo
Un StatInfo Contient le résultat d'un appel à Logger.stat().
Propriétés
| Nom | Type | Description |
|---|---|---|
size |
number | La taille (nombre d'octets) du fichier de journal. |