Passer au contenu

logging — Journalisation Avancés

Code source: BLuau/Libraries/logging/__init.luau

Informations

Ce module définit des fonctions qui implémentent un système de journalisation d'événement flexible pour les bibliothèques et pour votre code.

Le principale avantage de disposer de l'API de journalisation fournie par un module de la bibliothèque standard est que tous les modules de BLuau peuvent utiliser la journalisation, de sorte que votre journal peut inclure vos propres messages intégrés aux messages de modules tiers.

La seule partie de BLuau qui n'utilise pas la journalisation sont les fichiers internes pour pouvoir éviter les problèmes de conflit et de boucle dans certains cas.

Le système de journalisation contient différents niveaux de priorité que vous pouvez vous-mêmes créer. Il est possible de configurer le comportement de l'enregistreur et de valider certains niveaux de journalisation dans l'environnement Roblox.

Configuration

ParamètresDescriptions
Module.__levelsNiveau de priorité de la journalisation.
Module.__loggerActiver ou désactiver l'enregistrement des logs.

Ces paramètres peuvent être modifié via la fonction logging.config() qui permet de configurer le module.

Fonctions


Configurer le module

logging.config(logger, levelName)

Configure le module de journalisation.

Cette fonction doit être appelé au lancement du serveur et ne doit pas être appelé plusieurs fois pour éviter tout conflit entre différente requête.

luau
logging.config(true, "INFO")

Paramètres

ArgumentsDescriptions
logger: Boolean?Activer ou désactiver l'enregistrement des logs.
levelName: String?Niveau de priorité de la journalisation.

Retours

ValeursDescriptions
TableContient la dernière configuration valide du module.
Boolean?Renvoie false si des valeurs non valides sont fournies.

Envoyer un log

logging.log(message, levelName)

Enregistre un message avec le niveau de journalisation spécifié.

luau
logging.log("YOUR_MESSAGE", "LEVEL_NAME")

Paramètres

ArgumentsDescriptions
message: String?Le message à enregistrer.
levelName: String?Niveau de priorité de la journalisation.

Retours

ValeursDescriptions
TableContient les informations du journal.

Lire les logs

logging:GetLog()

Récupère les entrées du journal stockées dans le module Logger.

Effacer les logs

logging:Clear()

Efface toutes les entrées du journal enregistrées.

Publié sous Apache-2.0 License.